The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
catchError: Catch error and set build result to failuredeleteDir: Recursively delete the current directory from the workspacedir: Change current directoryecho: Print Messageerror: Error signalfileExists: Verify if file exists in workspaceisUnix: Checks if running on a Unix-like nodemail: Mailpwd: Determine current directoryreadFile: Read file from workspaceretry: Retry the body up to N timessleep: Sleepstash: Stash some files to be used later in the buildstep: General Build Steptimeout: Enforce time limittool: Use a tool from a predefined Tool Installationunstable: Set stage result to unstableunstash: Restore files previously stashedwaitUntil: Wait for conditionwarnError: Catch error and set build and stage result to unstablewithEnv: Set environment variableswrap: General Build WrapperwriteFile: Write file to workspacearchive: Archive artifactsgetContext: Get contextual object from internal APIsunarchive: Copy archived artifacts into the workspacewithContext: Use contextual object from internal APIs within a blockcatchError: Catch error and set build result to failurecatchError step. The behavior of the step when an exception is thrown can be configured to print a message, set a build result other than failure, change the stage result, or ignore certain kinds of exceptions that are used to interrupt the build.
This step is most useful when used in Declarative Pipeline or with the options to set the stage result or ignore build interruptions. Otherwise, consider using plain try-catch(-finally) blocks. It is also useful when using certain post-build actions (notifiers) originally defined for freestyle projects which pay attention to the result of the ongoing build.
node {
catchError {
sh 'might fail'
}
step([$class: 'Mailer', recipients: 'admin@somewhere'])
}
If the shell step fails, the Pipeline build’s status will be set to failed, so that the subsequent mail step will see that this build is failed. In the case of the mail sender, this means that it will send mail. (It may also send mail if this build succeeded but previous ones failed, and so on.) Even in that case, this step can be replaced by the following idiom:
node {
try {
sh 'might fail'
} catch (err) {
echo "Caught: ${err}"
currentBuild.result = 'FAILURE'
}
step([$class: 'Mailer', recipients: 'admin@somewhere'])
}
For other cases, plain try-catch(-finally) blocks may be used:
node {
sh './set-up.sh'
try {
sh 'might fail'
echo 'Succeeded!'
} catch (err) {
echo "Failed: ${err}"
} finally {
sh './tear-down.sh'
}
echo 'Printed whether above succeeded or failed.'
}
// …and the pipeline as a whole succeeds
See this document for background.
buildResult (optional)
SUCCESS if the current result is
UNSTABLE or worse. Use
SUCCESS or
null to keep the build result from being set when an error is caught.
StringcatchInterruptions (optional)
timeout step.
booleanmessage (optional)
StringstageResult (optional)
SUCCESS or
null to keep the stage result from being set when an error is caught.
StringdeleteDir: Recursively delete the current directory from the workspacedeleteDir step in a
dir step.
dir: Change current directorydir block will use this directory as current and any relative path will use it as base path.
path
Stringerror: Error signalthrow new Exception(), but this step will avoid printing a stack trace.
message
StringfileExists: Verify if file exists in workspacetrue | false.
file
/-separated) path to file within a workspace to verify its existence.
StringisUnix: Checks if running on a Unix-like nodenode is running on a Unix-like system (such as Linux or Mac OS X), false if Windows.
mail: Mailsubject
Stringbody
Stringbcc (optional)
Stringcc (optional)
Stringcharset (optional)
UTF-8
Stringfrom (optional)
StringmimeType (optional)
text/plain.
StringreplyTo (optional)
Stringto (optional)
Stringpwd: Determine current directorytmp (optional)
booleanreadFile: Read file from workspacefile
/-separated) path to file within a workspace to read.
Stringencoding (optional)
Stringretry: Retry the body up to N timescount
intsleep: Sleepsh 'sleep …'. May be used to pause one branch of
parallel while another proceeds.
time
intunit (optional)
NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYSstash: Stash some files to be used later in the buildstash and
unstash steps are designed for use with small files. For large data transfers, use the External Workspace Manager plugin, or use an external repository manager such as Nexus or Artifactory. This is because stashed files are archived in a compressed TAR, and with large files this demands considerable on-master resources, particularly CPU time. There's not a hard stash size limit, but between 5-100 MB you should probably consider alternatives.
name
StringallowEmpty (optional)
booleanexcludes (optional)
Stringincludes (optional)
**: all files.
dir.
StringuseDefaultExcludes (optional)
booleanstep: General Build StepThis is a special step that allows to call builders or post-build actions (as in freestyle or similar projects), in general "build steps". Just select the build step to call from the dropdown list and configure it as needed.
Note that only Pipeline-compatible steps will be shown in the list.
delegate
$class: 'A3Builder'project_file
Stringanalysis_ids
Stringpedantic_level
Stringexport_a3apxworkspace
Stringcopy_report_file
booleancopy_result_file
booleanskip_a3_analysis
boolean$class: 'ACIPluginPublisher'name
StringshownOnProjectPage
boolean$class: 'ACSDeploymentBuilder'context
azureCredentialsId
StringresourceGroupName
StringcontainerService
StringsshCredentialsId
The username and private key credential used to authenticate with the ACS clusters master node. This is the private key paired with the SSH RSA public key provided when you create the ACS cluster (see Deploy a Docker container hosting solution using the Azure portal ).
The username and key credentials can be updated from Azure Portal. Find the Virtual Machine for your ACS cluster master node from the portal, and you can update the credential from SUPPORT + TROUBLESHOOTING >>> Reset password page.
StringconfigFilePaths
The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.
StringcontainerRegistryCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdcosDockerCredenditalsPathShared (optional)
Determine if the Docker credentials archive upload path specified above is shared among all the agents.
To ease the shared files access, we may create share file storage for all the DC/OS agent nodes as this documentation (Create and mount a file share to a DC/OS cluster) suggests. With the help of the shared storage, we only need to upload the Docker credentials archive to the shared storage once, and all the agent nodes get the access to the resource immediately.
Check this option if the Docker credentials archive upload path is a shared storage path.
booleandcosDockerCredentialsPath (optional)
The path on the DC/OS cluster agent nodes to store the docker credentials archive docker.tar.gz. Only absolute path is allowed here. Environment variable substitution is enabled for the path input. Due to the limitation in the underlying Mesos fetcher used by Marathon, special characters that need URI escaping and the character set {single quote ('), back slash (\), nul (\0)}, are not allowed in the path, otherwise it will fail to load the resource before running the container.
If not specified, the plugin will generate a path specific for the build with the following pattern.
/home/<linuxAdminUser>/acs-plugin-dcos.docker/<unique-name-generated-for-the-build>
The plugin will generate the docker credentials archive with the credentials provided, and upload the archive to the given path for all the agents. You can use it to construct the URI used in your Marathon application definition.
"uris": [
"file://<filled-path>/docker.tar.gz"
]
The URI will be exposed with the environment variable $MARATHON_DOCKER_CFG_ARCHIVE_URI. You can use this in your Marathon application definition when the "Enable Variable Substitution in Config" option is enabled. This helps when the upload path is not filled and generated by the build, or if the path changes frequently.
Note that if an archive exists in the target path already, the build will overwrite that file.
Reference: Marathon: Using a Private Docker Registry
StringenableConfigSubstitution (optional)
$VARIABLE or
${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleansecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g.,
some-secret-$BUILD_NUMBER. The name should be in the pattern
[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See
Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
StringswarmRemoveContainersFirst (optional)
booleanpublishATXPublishes the ATX reports of all configured ECU-TEST packages or projects in this job.
These ATX reports are generated automatically in this post-build step and uploaded to TEST-GUIDE.
publishATX(String atxName, boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
publishATX(ATXInstallation installation, boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ATXServer.publish(boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
publishATX('TEST-GUIDE', false, false, true, true)
def server = ATX.server('TEST-GUIDE')
publishATX atxInstallation: server.installation
def server = ATX.newServer('TEST-GUIDE', 'ECU-TEST')
atx.publish()
atxName
StringallowMissing (optional)
booleanarchiving (optional)
booleanatxInstallation (optional)
name
StringtoolName
Stringconfig
settings
atxBooleanSettingname
Stringgroup
UPLOAD, ARCHIVE, ATTRIBUTE, TBC_CONSTANTS, TCF_CONSTANTS, SPECIALvalue
booleanatxTextSettingname
Stringgroup
UPLOAD, ARCHIVE, ATTRIBUTE, TBC_CONSTANTS, TCF_CONSTANTS, SPECIALvalue
StringcustomSettings
atxCustomBooleanSettingname
Stringchecked
booleanatxCustomTextSettingname
Stringvalue
StringkeepAll (optional)
booleanrunOnFailed (optional)
boolean$class: 'AWSCodeDeployPublisher's3bucket
Strings3prefix
StringapplicationName
StringdeploymentGroupName
StringdeploymentConfig
Stringregion
StringdeploymentGroupAppspec
If checked, the build will use a dedicated appspec.yml file per deployment group.
The appspec file should be named "appspec.DEPLOYMENT_GROUP_NAME.yml" and must be present in the jenkins project workspace.
e.g.: appsec.staging.yml
booleanwaitForCompletion
If checked, this build will wait for the AWS CodeDeploy deployment to finish (with either success or failure). Polling Timeout, below, sets the maximum amount of time to wait.
If unchecked, the deployment will be handed off to AWS CodeDeploy and the build will move on to the next step.
The build will be marked a failure if either the timeout is reached or the deployment fails. The build log will indicate which.
booleanpollingTimeoutSec
longpollingFreqSec
longcredentials
StringversionFileName
StringdeploymentMethod
StringawsAccessKey
AWS Access and Secret keys to use for this deployment. At minimum the keys must be allowed to execute codedeploy:* and s3:Put*. It's a best practice to have these keys be from an IAM role with limited scope.
If your Jenkins install is running on an EC2 instance with an associate IAM role, you can leave these fields blank. You will just need to ensure that the role has the correct policies.
StringawsSecretKey
AWS Access and Secret keys to use for this deployment. At minimum the keys must be allowed to execute codedeploy:* and s3:Put*. It's a best practice to have these keys be from an IAM role with limited scope.
If your Jenkins install is running on an EC2 instance with an associate IAM role, you can leave these fields blank. You will just need to ensure that the role has the correct policies.
StringiamRoleArn
In order to keep your application(s) more secure, this plugin only uses temporary credentials via STS, scoped to each application. To set this up:
{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["codedeploy:*", "s3:*"], "Resource": "*"}]}StringexternalId
Stringincludes
StringproxyHost
Proxy host DNS name
StringproxyPort
Proxy host port
intexcludes
Stringsubdirectory
StringdevicefarmprojectName
StringdevicePoolName
StringtestSpecName
StringenvironmentToRun
StringappArtifact
StringrunName
StringtestToRun
StringstoreResults
booleanisRunUnmetered
booleaneventCount
StringeventThrottle
Stringseed
Stringusername
Stringpassword
StringappiumJavaJUnitTest
StringappiumJavaTestNGTest
StringappiumPythonTest
StringappiumRubyTest
StringappiumNodeTest
StringcalabashFeatures
StringcalabashTags
StringcalabashProfile
StringjunitArtifact
StringjunitFilter
StringuiautomatorArtifact
StringuiautomatorFilter
StringuiautomationArtifact
StringxctestArtifact
StringxctestFilter
StringxctestUiArtifact
StringxctestUiFilter
StringappiumVersionJunit
StringappiumVersionPython
StringappiumVersionTestng
StringifWebApp
booleanextraData
booleanextraDataArtifact
StringdeviceLocation
booleandeviceLatitude
doubledeviceLongitude
doubleradioDetails
booleanifBluetooth
booleanifWifi
booleanifGPS
booleanifNfc
booleanjobTimeoutMinutes
intifVideoRecording
booleanifAppPerformanceMonitoring
booleanignoreRunError
booleanifVpce
booleanifSkipAppResigning
booleanvpceServiceName
String$class: 'AWSEBDeploymentBuilder'credentialId
StringawsRegion
StringapplicationName
StringenvironmentName
Optional: AWS EB Environment name(s) to deploy to.
Can accept single or multiple comma-separated values. Examples:
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
StringbucketName
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation if blank)
StringkeyPrefix
StringversionLabelFormat
StringversionDescriptionFormat
StringrootObject
Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
Examples:
target/mywebapp.war: The war file will be uploaded.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes). Stringincludes
Stringexcludes
StringzeroDowntime
booleansleepTime
intcheckHealth
booleanmaxAttempts
int$class: 'AddTestToSetStep'domain
Stringproject
StringtestPlanPath
StringtestSetPath
StringalaudaDeleteBuildbuildID (optional)
StringalaudaStartBuildbuildConfigName (optional)
Stringasync (optional)
booleanbranch (optional)
StringcommitID (optional)
StringspaceName (optional)
String$class: 'AlaudaNotifier'name (optional)
Stringbody (optional)
StringspaceName (optional)
Stringallureresults
path
Stringcommandline (optional)
Stringconfig (optional)
results
path
Stringcommandline (optional)
StringconfigPath (optional)
StringincludeProperties (optional)
booleanjdk (optional)
Stringproperties (optional)
key
Stringvalue
StringreportBuildPolicy (optional)
ALWAYS, UNSTABLE, UNSUCCESSFULconfigPath (optional)
Stringdisabled (optional)
booleanincludeProperties (optional)
booleanjdk (optional)
Stringproperties (optional)
key
Stringvalue
Stringreport (optional)
StringreportBuildPolicy (optional)
ALWAYS, UNSTABLE, UNSUCCESSFUL$class: 'AnalysisPublisher'androidLintActivated (optional)
booleancanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleancheckStyleActivated (optional)
booleandefaultEncoding (optional)
StringdryActivated (optional)
booleanfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
StringfindBugsActivated (optional)
booleanhealthy (optional)
StringopenTasksActivated (optional)
booleanpmdActivated (optional)
booleanshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
booleanwarningsActivated (optional)
booleananchorename
StringanchoreioPass (optional)
StringanchoreioUser (optional)
Stringannotations (optional)
key
Stringvalue
StringautoSubscribeTagUpdates (optional)
booleanbailOnFail (optional)
booleanbailOnPluginFail (optional)
booleanbailOnWarn (optional)
booleanbundleFileOverride (optional)
StringdoCleanup (optional)
booleanengineCredentialsId (optional)
StringengineRetries (optional)
Stringengineurl (optional)
Stringengineverify (optional)
booleanforceAnalyze (optional)
booleanglobalWhiteList (optional)
StringinputQueries (optional)
query
StringpolicyBundleId (optional)
StringpolicyEvalMethod (optional)
StringpolicyName (optional)
StringuseCachedBundle (optional)
booleanuserScripts (optional)
String$class: 'AnsibleAdHocCommandBuilder'hostPattern
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
Stringmodule
Stringcommand
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleansudo (optional)
booleansudoUser (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsiblePlaybookBuilder'playbook
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleanlimit (optional)
StringskippedTags (optional)
StringstartAtTask (optional)
Stringsudo (optional)
booleansudoUser (optional)
Stringtags (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsibleVaultBuilder'action (optional)
StringansibleName (optional)
Stringcontent (optional)
Stringinput (optional)
StringnewVaultCredentialsId (optional)
Stringoutput (optional)
StringvaultCredentialsId (optional)
StringandroidApkUploadapkFilesPattern (optional)
StringdeobfuscationFilesPattern (optional)
StringexpansionFilesPattern (optional)
StringgoogleCredentialsId (optional)
StringrecentChangeList (optional)
language
Stringtext
StringrolloutPercentage (optional)
StringtrackName (optional)
StringusePreviousExpansionFilesIfMissing (optional)
booleanappCenterapiToken
StringownerName
StringappName
StringpathToApp
Stringappscanscanner
dynamic_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
Stringoptimization (optional)
StringpresenceId (optional)
StringscanFile (optional)
StringscanType (optional)
StringtestPolicy (optional)
Stringmobile_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
StringpresenceId (optional)
Stringstatic_analyzertarget
StringhasOptions
booleanopenSourceOnly (optional)
booleanname
Stringtype
Stringapplication
Stringcredentials
Stringemail (optional)
booleanfailBuild (optional)
booleanfailBuildNonCompliance (optional)
booleanfailureConditions (optional)
failureType
Stringthreshold
inttarget (optional)
Stringwait (optional)
boolean$class: 'AppScanSourceBuilder'disableScan
booleanapplicationFile
StringacceptSSL
booleancustomScanWorkspace
This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.
If this field is blank, the default scan directory will be used.
The default directory is this job's build folder, as defined by Jenkins.
Stringinstallation (optional)
String$class: 'AppScanStandardBuilder'startingURL
Spiders will find the remaining URLs in the domain to be included for scanning.
Stringinstallation
StringadditionalCommands (optional)
AppScanCMD exec|ex|e
Parameters:
[ /dest_scan|/dest|/d ]
[ /base_scan|/base|/b ]
[ /old_host|/ohost|/oh ]
[ /new_host|/nhost|/nh ]
[ /scan_template|/stemplate|/st ]
[ /login_file|/lfile|/lf ]
[ /multi_step_file|/mstepfile|/mf ]
[ /manual_explore_file|/mexplorefile|/mef ]
[ /policy_file|/pfile|/pf ]
[ /additional_domains|/adomains|/ad ]
[ /report_file|/rf ]
[ /report_type|/rt {xml} ]
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
[ /scan_log|/sl {false} ]
[ /explore_only|/eo {false} ]
[ /test_only|/to {false} ]
[ /multi_step|/mstep|/ms {false} ]
[ /continue|/c {false} ]
[ /merge_manual_explore_requests|/mmer {false} ]
[ /include_responses|/ir {false} ]
[ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ]
Creates new scan with base_scan's configuration
saving dest_scan and creating report, if configured.
AppScanCMD report|rep|r
Parametrs:
/base_scan|/base|/b
/report_file|/rf
/report_type|/rt
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
Creates a report for base_scan.
AppScanCMD close_proxy|cprxy|cpr
Closes AppScan proxy if was previously opened.
More info. at:
(9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315
http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
StringauthScan (optional)
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
booleanauthScanPw (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringauthScanRadio (optional)
A login sequence may be recorded using AppScan Standard's GUI by following these steps:
"Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
booleanauthScanUser (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringgenerateReport (optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
booleanhtmlReport (optional)
booleanincludeURLS (optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
StringpathRecordedLoginSequence (optional)
StringpdfReport (optional)
booleanpolicyFile (optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
StringreportName (optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
Stringverbose (optional)
booleanxooaname
StringappId
String$class: 'ApperianRecorder'uploads
prodEnv
Choose the production environment to which the plugin will connect. If you aren’t sure which environment to choose, contact Customer Support at support@arxan.com.
StringcustomApperianUrl
StringapiTokenId
Choose an API token to use for authenticating your Apperian organization.
To include additional tokens in this list, go to Jenkins > Credentials and add a new Global Credential. In the Kind field, choose Secret Text, set Scope to Global, and add your API token in the Secret field.
The user associated with the API token must have valid permissions for adding apps in Apperian. For more information on user permissions, see Managing Users.
StringappId
To update an existing app, choose it from this list of native apps currently stored in your Apperian organization.
Stringfilename
Specify the filename pattern that this plugin will use to search for and upload the app file from your workspace.
If your project builds multiple versions of the app binary (for example, signed and unsigned), use this field to explicitly specify the correct file in the workspace. For example: target/android-app-v*.apk.
StringappName
StringshortDescription
StringlongDescription
Stringauthor
Stringversion
StringversionNotes
StringsignApp
booleancredential
Choose the credentials you want to use to sign the app. If no credentials are listed, or if you need to add different credentials, see Managing Signing Credentials.
Remember, when you re-sign an iOS or Android app that was already installed on any of your users' devices, it is important that you sign it with the same signing credentials used to previously sign it.
StringenableApp
booleanreapplyPolicies
booleanapplatixaxUrl
StringaxUsername
StringaxPassword
StringaxServiceTemplateName
StringaxServiceTemplateRepository
StringaxServiceTemplateBranch
StringaxServiceTemplateParameters
key
Stringvalue
String$class: 'ApprendaBuilder'appAlias
StringappName
StringversionAlias
Stringstage
StringartifactName
StringcredentialsId
Stringprefix
StringadvVersionAliasToBeForced
StringadvancedNewVersionOption
StringcustomPackageDirectory
StringapplicationPackageURL
StringarchiveUploadMethod
StringbuildWithParameters
booleanaqualocationType
Stringregistry
Stringregister
booleanlocalImage
StringhostedImage
StringonDisallowed
StringnotCompliesCmd
StringhideBase
booleanshowNegligible
booleanpolicies
StringcustomFlags
StringaquaMicroscannerimageName
StringonDisallowed
StringnotCompliesCmd
StringoutputFormat
StringaquaServerlessScanneronDisallowed
StringnotCompliesCmd
StringcodeScanPath
StringcustomFlags
StringarachniScannerurl
Stringchecks
Stringscope
pageLimit
intexcludePathPattern
StringuserConfig
filename
Stringformat
StringarestocatsmetricsDatafilesPattern
StringresultsDatafilesPattern
StringnumBuilds
intarchiveArtifactsartifacts
StringallowEmptyArchive (optional)
booleancaseSensitive (optional)
org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
booleandefaultExcludes (optional)
booleanexcludes (optional)
Stringfingerprint (optional)
booleanonlyIfSuccessful (optional)
boolean$class: 'ArtifactPromotionBuilder'groupId
StringartifactId
Stringclassifier
Stringversion
Stringextension
StringstagingRepository
StringstagingUser
StringstagingPW
StringreleaseUser
StringreleasePW
StringreleaseRepository
StringpromoterClass
Stringdebug
booleanskipDeletion
'Skip deletion' option preserves the files in the staging repository.
Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.
booleanartifactResolver Define the artifacts you would like to download.
The target directory defines where the artifacts should be copied to. The coordinates are as you know it from maven or ivy:
artifacts
groupId
StringartifactId
Stringversion
Stringclassifier (optional)
Stringextension (optional)
StringtargetFileName (optional)
StringenableRepoLogging (optional)
booleanfailOnError (optional)
booleanreleaseChecksumPolicy (optional)
StringreleaseUpdatePolicy (optional)
StringsnapshotChecksumPolicy (optional)
StringsnapshotUpdatePolicy (optional)
StringtargetDirectory (optional)
StringassertthatBddFeaturesprojectId
StringcredentialsId
StringoutputFolder
Stringjql
Stringmode
StringassertthatBddReportprojectId
StringcredentialsId
StringjsonReportFolder
StringjsonReportIncludePattern
StringrunName
Stringtype
StringassociateTagnexusInstanceId
StringtagName
Stringsearch
key
Stringvalue
String$class: 'AstreeBuilder'dax_file
Stringanalysis_id
Stringoutput_dir
Stringskip_analysis
booleangenXMLOverview
booleangenXMLCoverage
booleangenXMLAlarmsByOccurence
booleangenXMLAlarmsByCategory
booleangenXMLAlarmsByFile
booleangenXMLRulechecks
booleandropAnalysis
booleangenPreprocessOutput
booleanfailonswitch
failon
StringazureCLIprincipalCredentialId
Stringcommands
script
StringexportVariablesString
StringazureDownloadstorageCredentialId
StringdownloadType
StringbuildSelector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacecontainerName (optional)
StringdeleteFromAzureAfterDownload (optional)
booleandownloadDirLoc (optional)
StringexcludeFilesPattern (optional)
StringfileShare (optional)
StringflattenDirectories (optional)
booleanincludeArchiveZips (optional)
booleanincludeFilesPattern (optional)
StringprojectName (optional)
String$class: 'BapFtpPromotionPublisherPlugin'publishers
configName
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringasciiMode
Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.
Use with ASCII text files to fix the line terminators when transferring between different operating systems.
booleanremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
Select to delete all files and directories within the remote directory before transferring files.
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleanftpRetry
If publishing to this server fails, try again.
Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
retries
intretryDelay
longftpLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringftpCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
username
Stringpassword
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
StringftpPublisherpublishers
configName
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringasciiMode
Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.
Use with ASCII text files to fix the line terminators when transferring between different operating systems.
booleanremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
Select to delete all files and directories within the remote directory before transferring files.
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleanftpRetry
If publishing to this server fails, try again.
Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
retries
intretryDelay
longftpLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringftpCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
username
Stringpassword
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
Select to publish from the Jenkins master.
The default is to publish from the server that holds the files to transfer (workspace on the slave, or artifacts directory on the master)
Enabling this option could help dealing with strict network configurations and firewall rules.
This option will cause the files to be transferred through the master before being sent to the remote server, this may increase network traffic, and could increase the build time.
booleanmasterNodeName
Set the NODE_NAME for the master Jenkins.
Set this option to give a value to the NODE_NAME environment variable when the value is missing (the Jenkins master).
This is useful if you use the $NODE_NAME variable in the remoteDirectory option and the build may occur on the master.
StringparamPublish
parameterName
String$class: 'BapSshPromotionPublisherPlugin'publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringexecCommand (optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
StringexecTimeout (optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
intusePty (optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in
to a real tty. When this flag is set, sudo can only be
run from a login session and not via other means such
as cron(8) or cgi-bin scripts. This flag is off by
default.
booleanuseAgentForwarding (optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file.
Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
booleanuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleansshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
intretryDelay
longsshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringsshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
StringencryptedPassphrase
Key or
Path to key is configured.
Stringkey
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key.
StringkeyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key box.
The Path to key can be absolute, or relative to $JENKINS_HOME
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
StringsshPublisheralwaysPublishFromMaster (optional)
Select to publish from the Jenkins master.
The default is to publish from the server that holds the files to transfer (workspace on the slave, or artifacts directory on the master)
Enabling this option could help dealing with strict network configurations and firewall rules.
This option will cause the files to be transferred through the master before being sent to the remote server, this may increase network traffic, and could increase the build time.
booleancontinueOnError (optional)
booleanfailOnError (optional)
booleanmasterNodeName (optional)
Set the NODE_NAME for the master Jenkins.
Set this option to give a value to the NODE_NAME environment variable when the value is missing (the Jenkins master).
This is useful if you use the $NODE_NAME variable in the remote directory option and the build may occur on the master.
StringparamPublish (optional)
parameterName
Stringpublishers (optional)
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringexecCommand (optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
StringexecTimeout (optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
intusePty (optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in
to a real tty. When this flag is set, sudo can only be
run from a login session and not via other means such
as cron(8) or cgi-bin scripts. This flag is off by
default.
booleanuseAgentForwarding (optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file.
Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
booleanuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleansshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
intretryDelay
longsshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringsshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
StringencryptedPassphrase
Key or
Path to key is configured.
Stringkey
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key.
StringkeyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key box.
The Path to key can be absolute, or relative to $JENKINS_HOME
Stringbenchmarkfilepath
StringbenchmarkThe Benchmark Plugin collect and display boolean and numeral results. The results may come from one or multiple files. The result may be either in XML or JSON format. The content of the file may follow either a standard or a custom schema. The schema type may be selected using the drop-down menu and the custom schema entered in the associated text area.
In addition, the Benchmark Plugin provides the capability to associate different types of thresholds on numerical values to one or multiple results. If crossed, the thresholds will identify results as failures and ultimately trigger the build failure.The Benchmark Plugin, if successful, provides access to two pages where results are displayed. One with tables compiling information on all results and one with the details for a specific result.
inputLocation
StringschemaSelection
StringtruncateStrings
booleanaltInputSchema
StringaltInputSchemaLocation
Stringthresholds (optional)
org.jenkinsci.plugins.benchmark.thresholds.Threshold
$class: 'BitbucketPublisher'serverUrl (optional)
StringcredentialsId (optional)
StringprojectKey (optional)
StringcreateProject (optional)
projectName
StringprojectUsers
StringprojectGroups
StringcreateJenkinsJobs (optional)
ciServer
StringprojectName (optional)
String$class: 'BlueprintLaunch'projectName
Project selection is mandatory.
StringblueprintName
Blueprint selection is mandatory.
StringapplicationName
Application Name is mandatory.
This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.
StringappProfileName
Application Profile selection is mandatory.
StringactionName
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringwaitForSuccessFulLaunch
booleanblueprintDescription
Description is fetched from the selected Calm blueprint
String$class: 'BrakemanPublisher'outputFile
StringcanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
booleanbuildDescriptiondescriptionTemplate
StringbuildNamenameTemplate
StringcrxBuildpackageId (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
Stringdownload (optional)
booleanlocalDirectory (optional)
StringrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longwspFilter (optional)
/etc # define /etc as the filter root
+/etc(/.*)? # include everything under /etc
-/etc/packages(/.)? # exclude package paths
To create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:
/content/acme # include the site content
/apps/acme # include the app code
This field supports parameter tokens.
String$class: 'BuildScanner'profile
Stringtarget
StringrepTemp
Stringthreat
StringstopScan
boolean$class: 'BuildStepsFromJsonBuilder'buildStep
$class: 'A3Builder'project_file
Stringanalysis_ids
Stringpedantic_level
Stringexport_a3apxworkspace
Stringcopy_report_file
booleancopy_result_file
booleanskip_a3_analysis
boolean$class: 'ACSDeploymentBuilder'context
azureCredentialsId
StringresourceGroupName
StringcontainerService
StringsshCredentialsId
The username and private key credential used to authenticate with the ACS clusters master node. This is the private key paired with the SSH RSA public key provided when you create the ACS cluster (see Deploy a Docker container hosting solution using the Azure portal ).
The username and key credentials can be updated from Azure Portal. Find the Virtual Machine for your ACS cluster master node from the portal, and you can update the credential from SUPPORT + TROUBLESHOOTING >>> Reset password page.
StringconfigFilePaths
The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.
StringcontainerRegistryCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdcosDockerCredenditalsPathShared (optional)
Determine if the Docker credentials archive upload path specified above is shared among all the agents.
To ease the shared files access, we may create share file storage for all the DC/OS agent nodes as this documentation (Create and mount a file share to a DC/OS cluster) suggests. With the help of the shared storage, we only need to upload the Docker credentials archive to the shared storage once, and all the agent nodes get the access to the resource immediately.
Check this option if the Docker credentials archive upload path is a shared storage path.
booleandcosDockerCredentialsPath (optional)
The path on the DC/OS cluster agent nodes to store the docker credentials archive docker.tar.gz. Only absolute path is allowed here. Environment variable substitution is enabled for the path input. Due to the limitation in the underlying Mesos fetcher used by Marathon, special characters that need URI escaping and the character set {single quote ('), back slash (\), nul (\0)}, are not allowed in the path, otherwise it will fail to load the resource before running the container.
If not specified, the plugin will generate a path specific for the build with the following pattern.
/home/<linuxAdminUser>/acs-plugin-dcos.docker/<unique-name-generated-for-the-build>
The plugin will generate the docker credentials archive with the credentials provided, and upload the archive to the given path for all the agents. You can use it to construct the URI used in your Marathon application definition.
"uris": [
"file://<filled-path>/docker.tar.gz"
]
The URI will be exposed with the environment variable $MARATHON_DOCKER_CFG_ARCHIVE_URI. You can use this in your Marathon application definition when the "Enable Variable Substitution in Config" option is enabled. This helps when the upload path is not filled and generated by the build, or if the path changes frequently.
Note that if an archive exists in the target path already, the build will overwrite that file.
Reference: Marathon: Using a Private Docker Registry
StringenableConfigSubstitution (optional)
$VARIABLE or
${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleansecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g.,
some-secret-$BUILD_NUMBER. The name should be in the pattern
[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See
Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
StringswarmRemoveContainersFirst (optional)
boolean$class: 'AWSEBBuilder'extensions
awsRegion
GovCloud, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1awsRegionText
StringcredentialsString
StringcredentialsText
StringapplicationName
StringversionLabelFormat
StringfailOnError
booleanextensions
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
StringenvLookup
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
String$class: 'AWSEBDeploymentBuilder'credentialId
StringawsRegion
StringapplicationName
StringenvironmentName
Optional: AWS EB Environment name(s) to deploy to.
Can accept single or multiple comma-separated values. Examples:
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
StringbucketName
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation if blank)
StringkeyPrefix
StringversionLabelFormat
StringversionDescriptionFormat
StringrootObject
Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
Examples:
target/mywebapp.war: The war file will be uploaded.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes). Stringincludes
Stringexcludes
StringzeroDowntime
booleansleepTime
intcheckHealth
booleanmaxAttempts
int$class: 'ActionHubPlugin'$class: 'AddTestToSetStep'domain
Stringproject
StringtestPlanPath
StringtestSetPath
String$class: 'AmxEclipseAntBuilder'targets
Stringname
Jenkins supplies some environment variables that can be used from within the build script.
StringantOpts
StringbuildFile
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
StringamxEclipseAntTra
StringbusinessStudioWs
Stringanchorename
StringanchoreioPass (optional)
StringanchoreioUser (optional)
Stringannotations (optional)
key
Stringvalue
StringautoSubscribeTagUpdates (optional)
booleanbailOnFail (optional)
booleanbailOnPluginFail (optional)
booleanbailOnWarn (optional)
booleanbundleFileOverride (optional)
StringdoCleanup (optional)
booleanengineCredentialsId (optional)
StringengineRetries (optional)
Stringengineurl (optional)
Stringengineverify (optional)
booleanforceAnalyze (optional)
booleanglobalWhiteList (optional)
StringinputQueries (optional)
query
StringpolicyBundleId (optional)
StringpolicyEvalMethod (optional)
StringpolicyName (optional)
StringuseCachedBundle (optional)
booleanuserScripts (optional)
String$class: 'AnsibleAdHocCommandBuilder'hostPattern
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
Stringmodule
Stringcommand
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleansudo (optional)
booleansudoUser (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsiblePlaybookBuilder'playbook
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleanlimit (optional)
StringskippedTags (optional)
StringstartAtTask (optional)
Stringsudo (optional)
booleansudoUser (optional)
Stringtags (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsibleTower'towerServer (optional)
StringjobTemplate (optional)
StringjobType (optional)
StringextraVars (optional)
StringjobTags (optional)
StringskipJobTags (optional)
Stringlimit (optional)
Stringinventory (optional)
Stringcredential (optional)
Stringverbose (optional)
booleanimportTowerLogs (optional)
booleanremoveColor (optional)
booleantemplateType (optional)
StringimportWorkflowChildLogs (optional)
boolean$class: 'AnsibleVaultBuilder'action (optional)
StringansibleName (optional)
Stringcontent (optional)
Stringinput (optional)
StringnewVaultCredentialsId (optional)
Stringoutput (optional)
StringvaultCredentialsId (optional)
StringantJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'AntExec'scriptSource
StringextendedScriptSource
StringscriptName
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
StringantName
StringantOpts
StringkeepBuildfile
booleanverbose
booleanemacs
booleannoAntcontrib
Disabling usage of Ant-Contrib Tasks in this build step.
booleanantwsJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'ApiFortressBuilder'mode
Stringhook
Stringid
Stringblocking
booleandryrun
booleansilent
booleanparam1name
Stringparam1value
Stringparam2name
Stringparam2value
Stringparam3name
Stringparam3value
String$class: 'AppClone'apiKey
StringappName
StringtemplateAppName
Stringappscanscanner
dynamic_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
Stringoptimization (optional)
StringpresenceId (optional)
StringscanFile (optional)
StringscanType (optional)
StringtestPolicy (optional)
Stringmobile_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
StringpresenceId (optional)
Stringstatic_analyzertarget
StringhasOptions
booleanopenSourceOnly (optional)
booleanname
Stringtype
Stringapplication
Stringcredentials
Stringemail (optional)
booleanfailBuild (optional)
booleanfailBuildNonCompliance (optional)
booleanfailureConditions (optional)
failureType
Stringthreshold
inttarget (optional)
Stringwait (optional)
boolean$class: 'AppScanSourceBuilder'disableScan
booleanapplicationFile
StringacceptSSL
booleancustomScanWorkspace
This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.
If this field is blank, the default scan directory will be used.
The default directory is this job's build folder, as defined by Jenkins.
Stringinstallation (optional)
String$class: 'AppScanStandardBuilder'startingURL
Spiders will find the remaining URLs in the domain to be included for scanning.
Stringinstallation
StringadditionalCommands (optional)
AppScanCMD exec|ex|e
Parameters:
[ /dest_scan|/dest|/d ]
[ /base_scan|/base|/b ]
[ /old_host|/ohost|/oh ]
[ /new_host|/nhost|/nh ]
[ /scan_template|/stemplate|/st ]
[ /login_file|/lfile|/lf ]
[ /multi_step_file|/mstepfile|/mf ]
[ /manual_explore_file|/mexplorefile|/mef ]
[ /policy_file|/pfile|/pf ]
[ /additional_domains|/adomains|/ad ]
[ /report_file|/rf ]
[ /report_type|/rt {xml} ]
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
[ /scan_log|/sl {false} ]
[ /explore_only|/eo {false} ]
[ /test_only|/to {false} ]
[ /multi_step|/mstep|/ms {false} ]
[ /continue|/c {false} ]
[ /merge_manual_explore_requests|/mmer {false} ]
[ /include_responses|/ir {false} ]
[ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ]
Creates new scan with base_scan's configuration
saving dest_scan and creating report, if configured.
AppScanCMD report|rep|r
Parametrs:
/base_scan|/base|/b
/report_file|/rf
/report_type|/rt
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
Creates a report for base_scan.
AppScanCMD close_proxy|cprxy|cpr
Closes AppScan proxy if was previously opened.
More info. at:
(9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315
http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
StringauthScan (optional)
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
booleanauthScanPw (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringauthScanRadio (optional)
A login sequence may be recorded using AppScan Standard's GUI by following these steps:
"Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
booleanauthScanUser (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringgenerateReport (optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
booleanhtmlReport (optional)
booleanincludeURLS (optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
StringpathRecordedLoginSequence (optional)
StringpdfReport (optional)
booleanpolicyFile (optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
StringreportName (optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
Stringverbose (optional)
booleanxooaname
StringappId
String$class: 'AppUploaderBuilder'buildFilePath
StringapplatixaxUrl
StringaxUsername
StringaxPassword
StringaxServiceTemplateName
StringaxServiceTemplateRepository
StringaxServiceTemplateBranch
StringaxServiceTemplateParameters
key
Stringvalue
String$class: 'ApprendaBuilder'appAlias
StringappName
StringversionAlias
Stringstage
StringartifactName
StringcredentialsId
Stringprefix
StringadvVersionAliasToBeForced
StringadvancedNewVersionOption
StringcustomPackageDirectory
StringapplicationPackageURL
StringarchiveUploadMethod
StringbuildWithParameters
booleanaqualocationType
Stringregistry
Stringregister
booleanlocalImage
StringhostedImage
StringonDisallowed
StringnotCompliesCmd
StringhideBase
booleanshowNegligible
booleanpolicies
StringcustomFlags
StringaquaMicroscannerimageName
StringonDisallowed
StringnotCompliesCmd
StringoutputFormat
StringaquaServerlessScanneronDisallowed
StringnotCompliesCmd
StringcodeScanPath
StringcustomFlags
StringarachniScannerurl
Stringchecks
Stringscope
pageLimit
intexcludePathPattern
StringuserConfig
filename
Stringformat
String$class: 'ArtifactPromotionBuilder'groupId
StringartifactId
Stringclassifier
Stringversion
Stringextension
StringstagingRepository
StringstagingUser
StringstagingPW
StringreleaseUser
StringreleasePW
StringreleaseRepository
StringpromoterClass
Stringdebug
booleanskipDeletion
'Skip deletion' option preserves the files in the staging repository.
Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.
booleanartifactResolver Define the artifacts you would like to download.
The target directory defines where the artifacts should be copied to. The coordinates are as you know it from maven or ivy:
artifacts
groupId
StringartifactId
Stringversion
Stringclassifier (optional)
Stringextension (optional)
StringtargetFileName (optional)
StringenableRepoLogging (optional)
booleanfailOnError (optional)
booleanreleaseChecksumPolicy (optional)
StringreleaseUpdatePolicy (optional)
StringsnapshotChecksumPolicy (optional)
StringsnapshotUpdatePolicy (optional)
StringtargetDirectory (optional)
String$class: 'ArtifactsUploadBuilder'projectName
Stringparameters
Stringselector
$class: 'ParameterizedBuildSelector'parameterName
String$class: 'PermalinkBuildSelector'id
String$class: 'SavedBuildSelector'$class: 'SpecificBuildSelector'buildNumber
String$class: 'StatusBuildSelector'stableOnly
boolean$class: 'TriggeredBuildSelector'fallback
boolean$class: 'WorkspaceSelector'filter
Stringtarget
Stringflatten
booleanoptional
booleanfingerprintArtifacts
booleanautoMedia
Type or select the item path in the media repository.
A path without an extension would be considered a folder into which the file/s will be uploaded.
If you specify a path of a file, that would be the name of the uploaded file in the repository.
StringassertthatBddFeaturesprojectId
StringcredentialsId
StringoutputFolder
Stringjql
Stringmode
String$class: 'AssetBuilder'name
Stringdescription
Stringversion
Stringvendor
Stringplatform
Stringarchitecture
Stringbits
Stringcpu
intmemory
intstorage
intinstallationScriptFilePath
StringmediaFilePaths
path
StringlicenseFilePath
StringdocumentationFilePath
StringassociateTagnexusInstanceId
StringtagName
Stringsearch
key
Stringvalue
String$class: 'AstreeBuilder'dax_file
Stringanalysis_id
Stringoutput_dir
Stringskip_analysis
booleangenXMLOverview
booleangenXMLCoverage
booleangenXMLAlarmsByOccurence
booleangenXMLAlarmsByCategory
booleangenXMLAlarmsByFile
booleangenXMLRulechecks
booleandropAnalysis
booleangenPreprocessOutput
booleanfailonswitch
failon
String$class: 'AutEnvironmentBuilder'autEnvironmentModel
almServerName
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringclientType
StringautEnvironmentId
StringuseExistingAutEnvConf
booleanexistingAutEnvConfId
StringcreateNewAutEnvConf
booleannewAutEnvConfName
StringautEnvironmentParameters
name
Stringvalue
StringparamType
StringshouldGetOnlyFirstValueFromJson
booleanpathToJsonFile
StringoutputParameter
String$class: 'AutoConfigBuilder'name
StringdiscobitUrl
StringdiscobitUser
StringdiscobitPassword
hudson.util.Secret
configurations
Stringcuuid
String$class: 'AwsBatchBuilder'jobname
Stringjobdefinition
Stringcommand
Stringjobqueue
Stringvcpu
Stringmemory
Stringretries
StringazureCLIprincipalCredentialId
Stringcommands
script
StringexportVariablesString
StringazureDownloadstorageCredentialId
StringdownloadType
StringbuildSelector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacecontainerName (optional)
StringdeleteFromAzureAfterDownload (optional)
booleandownloadDirLoc (optional)
StringexcludeFilesPattern (optional)
StringfileShare (optional)
StringflattenDirectories (optional)
booleanincludeArchiveZips (optional)
booleanincludeFilesPattern (optional)
StringprojectName (optional)
String$class: 'BDSBuilder'projectFile
Stringswitches
StringinstallationName
String$class: 'BapFtpBuilder'publishers
configName
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringasciiMode
Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.
Use with ASCII text files to fix the line terminators when transferring between different operating systems.
booleanremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
Select to delete all files and directories within the remote directory before transferring files.
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleanftpRetry
If publishing to this server fails, try again.
Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
retries
intretryDelay
longftpLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringftpCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
username
Stringpassword
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'BapSshBuilderPlugin'publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringexecCommand (optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
StringexecTimeout (optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
intusePty (optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in
to a real tty. When this flag is set, sudo can only be
run from a login session and not via other means such
as cron(8) or cgi-bin scripts. This flag is off by
default.
booleanuseAgentForwarding (optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file.
Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
booleanuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleansshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
intretryDelay
longsshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringsshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
StringencryptedPassphrase
Key or
Path to key is configured.
Stringkey
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key.
StringkeyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key box.
The Path to key can be absolute, or relative to $JENKINS_HOME
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
StringbatchFilecommand
String$class: 'BeakerBuilder'jobSource
$class: 'FileJobSource'jobPath
String$class: 'StringJobSource'jobContent
StringdownloadFiles
booleanbenchmarkfilepath
String$class: 'BitbucketPublisher'serverUrl (optional)
StringcredentialsId (optional)
StringprojectKey (optional)
StringcreateProject (optional)
projectName
StringprojectUsers
StringprojectGroups
StringcreateJenkinsJobs (optional)
ciServer
StringprojectName (optional)
String$class: 'BlueprintLaunch'projectName
Project selection is mandatory.
StringblueprintName
Blueprint selection is mandatory.
StringapplicationName
Application Name is mandatory.
This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.
StringappProfileName
Application Profile selection is mandatory.
StringactionName
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringwaitForSuccessFulLaunch
booleanblueprintDescription
Description is fetched from the selected Calm blueprint
String$class: 'BootPluginBuilder'tasks
StringjvmOpts
String$class: 'BranchDestructionStep'project
Stringbranch
String$class: 'BranchGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
String$class: 'BuildBuilder'dbFolder
value
vcsroot, subfolder, scaprojectsubfolder
StringprojectPath
Stringpackageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
Stringoptions
Stringfilter
StringpackageVersion
StringdlmDashboard
dlmDashboardHost
StringdlmDashboardPort
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringbuildDescriptiondescriptionTemplate
StringbuildNamenameTemplate
String$class: 'BuildNameUpdater'fromFile
booleanbuildName
StringfromMacro
booleanmacroTemplate
StringmacroFirst
booleancrxBuildpackageId (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
Stringdownload (optional)
booleanlocalDirectory (optional)
StringrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longwspFilter (optional)
/etc # define /etc as the filter root
+/etc(/.*)? # include everything under /etc
-/etc/packages(/.)? # exclude package paths
To create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:
/content/acme # include the site content
/apps/acme # include the app code
This field supports parameter tokens.
String$class: 'BuildScanner'profile
Stringtarget
StringrepTemp
Stringthreat
StringstopScan
boolean$class: 'BuildStepBuilder'sourceFolderMode
Stringsubfolder
StringpackageId
StringserverType
Stringserver
StringauthenticationType
StringuserName
Stringpassword
hudson.util.Secret
database
StringcompareOptions (optional)
String$class: 'BuildStepWithTimeout'buildStep
$class: 'BuildStepsFromJsonBuilder'$class: 'BuildoutBuilder'pythonName
StringbuildoutCfg
Stringnature
Stringcommand
StringignoreExitCode
booleanbyteguardGreettoken
Stringtask_id
String$class: 'CFLaunchBuilder'cfComposition
StringsetCFVars
vars
Variable
StringValue
String$class: 'CFLintBuilder'folder
StringcflintFolder
StringcflintExcludesFile
StringotherArgs
String$class: 'CIMessageBuilder'providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CIMessageSubscriberBuilder'Subscribe to the CI message bus and wait for a message matching the specified JMS selector.
The variable value specifies the name of an environment variable in which to place the received message body.
The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CToolBuilder'cmake -P <script file>) or command mode (
cmake -E <command>).
installationName
Stringarguments (optional)
StringignoredExitCodes (optional)
StringtoolId (optional)
StringworkingDir (optional)
StringgenerateCachecaches
type
A2L, ELF, BUS, MODEL, SERVICEfilePath
StringdbChannel
Stringclear
boolean$class: 'CallOtherJenkinsBuilder'hostName
StringjobName
Stringspan
Stringretry
StringuserName
Stringpassword
Stringparameters
String$class: 'CaptureIOSDeviceScreenshot'url
StringcloudTestServerID
StringadditionalOptions
StringcastechoinstallationName
StringsourcePath
StringapplicationName
StringdisplayLog (optional)
booleanlogPath (optional)
StringoutputPath (optional)
StringqualityGate (optional)
StringchangeAsmVerversionPattern
StringassemblyCompany (optional)
StringassemblyCopyright (optional)
StringassemblyCulture (optional)
StringassemblyDescription (optional)
StringassemblyFile (optional)
StringassemblyProduct (optional)
StringassemblyTitle (optional)
StringassemblyTrademark (optional)
StringregexPattern (optional)
StringreplacementPattern (optional)
String$class: 'ChangesetEvaluator'basePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
StringdropAll (optional)
booleanlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringtagOnSuccessfulBuild (optional)
booleantestRollbacks (optional)
booleanurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
StringchatterPost postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId
If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
See Identity Confirmation in the salesforce.com online help for more information.
Stringbody
StringbuildUrlTitle (optional)
StringrecordId (optional)
Stringserver (optional)
String$class: 'CheckGateBuilder'project
Stringgate
String$class: 'ChefBuilderConfiguration'url
Stringsinatraurl
Stringfilter
Stringusername
Stringport
intcommand
Stringprivatekey
Stringparallel
booleanfail
booleanchlAtuoActioncontent
StringbrowserString
StringrunScriptOnly
booleanrootPath
StringlibPath
String$class: 'ChrootBuilder'chrootName
StringignoreExit
booleanadditionalPackages
StringpackagesFile
Stringclear
booleancommand
StringloginAsRoot
booleannoUpdate
booleanforceInstall
boolean$class: 'CifsBuilderPlugin'publishers
configName
Stringverbose
booleantransfers
sourceFiles
Stringexcludes
StringremoteDirectory
StringremovePrefix
StringremoteDirectorySDF
booleanflatten
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
booleanpatternSeparator
StringuseWorkspaceInPromotion
booleanusePromotionTimestamp
booleanretry
retries
intretryDelay
longlabel
label
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'ClangScanBuildBuilder'target
StringtargetSdk
xcodebuild -showsdks
Stringconfig
StringclangInstallationName
StringxcodeProjectSubPath
Stringworkspace
Stringscheme
Stringscanbuildargs
Stringxcodebuildargs
StringoutputFolderName
StringgoogleStorageUploadcredentialsId
Stringbucket
Stringpattern
StringpathPrefix (optional)
StringsharedPublicly (optional)
booleanshowInline (optional)
booleanexamCleanTarget$class: 'ClifBuilder'clifName
StringclifOpts
StringtestPlanFile
StringreportDir
String$class: 'CloudBuildBuilder'input
credentialsId
Stringrequest
filefilename
Stringinlinerequest
Stringsource (optional)
localpath
.tgz or .tar.gz) or zip file (.zip), or .tgz) and uploaded to a temporary Cloud Storage bucket. Stringrepobranch (optional)
Stringcommit (optional)
StringprojectId (optional)
StringrepoName (optional)
Stringtag (optional)
Stringstoragebucket
Stringobject
StringsubstitutionList (optional)
items
key
_) and use only numbers, uppercase letters, and underscores (respecting the regular expression
_[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see
Build Requests - User-defined substitutions.
Stringvalue
Stringsubstitutions (optional)
java.lang.String>
$class: 'CloudFormationBuildStep'stacks
stackName
Name of the stack. The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters. You can pass Environment Variables into this field.
Stringdescription
StringcloudFormationRecipe
Stringparameters
The parameters to pass into the recipe. A comma separated list of key/value pairs. ie: key1=value1,key2=value2
You can pass environment variables as values to a stack parameters.
Stringtimeout
longawsAccessKey
StringawsSecretKey
StringawsRegion
US_East_Northern_Virginia, US_WEST_Oregon, US_WEST_Northern_California, EU_Ireland, EU_Frankfurt, Asia_Pacific_Singapore, Asia_Pacific_Sydney, Asia_Pacific_Tokyo, South_America_Sao_Paulosleep
longpushToCloudFoundrytarget
Stringorganization
StringcloudSpace
StringcredentialsId
StringmanifestChoice (optional)
appName (optional)
StringappPath (optional)
Stringbuildpack (optional)
Stringcommand (optional)
Stringdomain (optional)
StringenvVars (optional)
key
Stringvalue
Stringhostname (optional)
Stringinstances (optional)
StringmanifestFile (optional)
Stringmemory (optional)
StringnoRoute (optional)
StringservicesNames (optional)
name
Stringstack (optional)
Stringtimeout (optional)
Stringvalue (optional)
StringpluginTimeout (optional)
StringselfSigned (optional)
StringservicesToCreate (optional)
name
Stringtype
Stringplan
StringresetService (optional)
boolean$class: 'CloudShellConfig'buildStep
$class: 'StartSandbox'blueprintName
StringsandboxDuration
StringmaxWaitForSandboxAvailability
intsetupTimeout
intparams (optional)
StringsandboxDomain (optional)
StringsandboxName (optional)
String$class: 'CmakeBuilder'cmake -G with the given options.
CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
installationName
StringbuildDir (optional)
StringbuildType (optional)
StringcleanBuild (optional)
booleancmakeArgs (optional)
Stringgenerator (optional)
StringpreloadScript (optional)
StringsourceDir (optional)
Stringsteps (optional)
args (optional)
cmake (separated by spaces). Arguments may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
DESTDIR=${WORKSPACE}/artifacts all install here to instruct the tool to copy the artifacts to
DESTDIR. At least the
make and the
ninja tool allow overriding the installation directory that way.
StringenvVars (optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
Please note that macros (e.g. ${WORKSPACE}) will not be resolved by a pipeline script.
StringwithCmake (optional)
$CMAKE_BUILD_TOOL) or to have
cmake run the build tool (by invoking
cmake --build <dir>).
boolean$class: 'CocoaPodsBuilder'cleanpods
boolean$class: 'CodeAnalysisBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringobjects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringowner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringtype
StringobjectFolders
path
The path of the directory to use to analyse files. Please note that this is relative to the machine running the job.
Stringfilter
Stringrecurse
booleanreport
name
The base name of the reports, without an extension. If empty no reports will be generated.
Stringhtml
booleanjson
booleanxls
booleanxml
booleanruleSet
intfailConditions
halstead
Halstead level which will cause the code analysis to fail, exclude to ignore.
intmaintainability
Maintainability index level which will cause the code analysis to fail, exclude to ignore.
intmcCabe
McCabes level which will cause the code analysis to fail, exclude to ignore.
intTCR
Toad Code Rating level which will cause the code analysis to fail, exclude to ignore.
intruleViolations
If enabled, code analysis will fail on any violation for the selected rule set.
booleansyntaxErrors
If enabled, code analysis will fail on any syntax error.
booleanignoreWrappedPackages
If enabled, code analysis will fail when a wrapped package is found.
boolean$class: 'CodeBuilder'credentialsType
StringcredentialsId
StringproxyHost
StringproxyPort
StringawsAccessKey
StringawsSecretKey
hudson.util.Secret
awsSessionToken
Stringregion
StringprojectName
StringsourceVersion
StringsseAlgorithm
StringsourceControlType
StringlocalSourcePath
StringworkspaceSubdir
StringgitCloneDepthOverride
StringreportBuildStatusOverride
StringsecondarySourcesOverride
StringsecondarySourcesVersionOverride
StringartifactTypeOverride
StringartifactLocationOverride
StringartifactNameOverride
StringartifactNamespaceOverride
StringartifactPackagingOverride
StringartifactPathOverride
StringartifactEncryptionDisabledOverride
StringoverrideArtifactName
StringsecondaryArtifactsOverride
StringenvVariables
StringenvParameters
StringbuildSpecFile
StringbuildTimeoutOverride
StringsourceTypeOverride
StringsourceLocationOverride
StringenvironmentTypeOverride
StringimageOverride
StringcomputeTypeOverride
StringcacheTypeOverride
StringcacheLocationOverride
StringcloudWatchLogsStatusOverride
StringcloudWatchLogsGroupNameOverride
StringcloudWatchLogsStreamNameOverride
Strings3LogsStatusOverride
Strings3LogsLocationOverride
StringcertificateOverride
StringserviceRoleOverride
StringinsecureSslOverride
StringprivilegedModeOverride
StringcwlStreamingDisabled
StringexceptionFailureMode
String$class: 'CodeCoverageBuilder'connectionId
StringcredentialsId
StringanalysisPropertiesPath
StringanalysisProperties
String$class: 'CodeScanBuilder'projectKey
StringcommitOverride
Stringversion
StringemailReportTo
The list of user names in instance. Invalid usernames are skipped with a warning.
Setting the analysis mode to 'preview' will create a 'new issues' build report but will not update the database
StringanalysisMode
StringprojectBranch
Stringblocking
booleancodescenecredentialsId
StringdeltaAnalysisUrl
Stringrepository
StringanalyzeBranchDiff (optional)
booleananalyzeLatestIndividually (optional)
booleanbaseRevision (optional)
StringcouplingThresholdPercent (optional)
intfailOnDecliningCodeHealth (optional)
booleanfailOnFailedGoal (optional)
booleanletBuildPassOnFailedAnalysis (optional)
booleanmarkBuildAsUnstable (optional)
booleanriskThreshold (optional)
intuseBiomarkers (optional)
boolean$class: 'CodeStreamBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringpipelineName
StringwaitExec
booleanpipelineParams
value
Stringname
String$class: 'CodefreshPipelineBuilder'selectPipeline
cfPipeline
StringcfBranch
StringsetCFVars
vars
Variable
StringValue
String$class: 'CompareBuilder'outputFolder
Path to the folder in that should be used to store compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompareWithBaselineBuilder'outputFolder
Path to the folder in that should be used to store baseline compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompoundBuilder'role
Stringnumber
StringactualBuilder
$class: 'A3Builder'project_file
Stringanalysis_ids
Stringpedantic_level
Stringexport_a3apxworkspace
Stringcopy_report_file
booleancopy_result_file
booleanskip_a3_analysis
boolean$class: 'ACSDeploymentBuilder'context
azureCredentialsId
StringresourceGroupName
StringcontainerService
StringsshCredentialsId
The username and private key credential used to authenticate with the ACS clusters master node. This is the private key paired with the SSH RSA public key provided when you create the ACS cluster (see Deploy a Docker container hosting solution using the Azure portal ).
The username and key credentials can be updated from Azure Portal. Find the Virtual Machine for your ACS cluster master node from the portal, and you can update the credential from SUPPORT + TROUBLESHOOTING >>> Reset password page.
StringconfigFilePaths
The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.
StringcontainerRegistryCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdcosDockerCredenditalsPathShared (optional)
Determine if the Docker credentials archive upload path specified above is shared among all the agents.
To ease the shared files access, we may create share file storage for all the DC/OS agent nodes as this documentation (Create and mount a file share to a DC/OS cluster) suggests. With the help of the shared storage, we only need to upload the Docker credentials archive to the shared storage once, and all the agent nodes get the access to the resource immediately.
Check this option if the Docker credentials archive upload path is a shared storage path.
booleandcosDockerCredentialsPath (optional)
The path on the DC/OS cluster agent nodes to store the docker credentials archive docker.tar.gz. Only absolute path is allowed here. Environment variable substitution is enabled for the path input. Due to the limitation in the underlying Mesos fetcher used by Marathon, special characters that need URI escaping and the character set {single quote ('), back slash (\), nul (\0)}, are not allowed in the path, otherwise it will fail to load the resource before running the container.
If not specified, the plugin will generate a path specific for the build with the following pattern.
/home/<linuxAdminUser>/acs-plugin-dcos.docker/<unique-name-generated-for-the-build>
The plugin will generate the docker credentials archive with the credentials provided, and upload the archive to the given path for all the agents. You can use it to construct the URI used in your Marathon application definition.
"uris": [
"file://<filled-path>/docker.tar.gz"
]
The URI will be exposed with the environment variable $MARATHON_DOCKER_CFG_ARCHIVE_URI. You can use this in your Marathon application definition when the "Enable Variable Substitution in Config" option is enabled. This helps when the upload path is not filled and generated by the build, or if the path changes frequently.
Note that if an archive exists in the target path already, the build will overwrite that file.
Reference: Marathon: Using a Private Docker Registry
StringenableConfigSubstitution (optional)
$VARIABLE or
${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleansecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g.,
some-secret-$BUILD_NUMBER. The name should be in the pattern
[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See
Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
StringswarmRemoveContainersFirst (optional)
boolean$class: 'AWSEBBuilder'extensions
awsRegion
GovCloud, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1awsRegionText
StringcredentialsString
StringcredentialsText
StringapplicationName
StringversionLabelFormat
StringfailOnError
booleanextensions
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
StringenvLookup
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
String$class: 'AWSEBDeploymentBuilder'credentialId
StringawsRegion
StringapplicationName
StringenvironmentName
Optional: AWS EB Environment name(s) to deploy to.
Can accept single or multiple comma-separated values. Examples:
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
StringbucketName
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation if blank)
StringkeyPrefix
StringversionLabelFormat
StringversionDescriptionFormat
StringrootObject
Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
Examples:
target/mywebapp.war: The war file will be uploaded.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes). Stringincludes
Stringexcludes
StringzeroDowntime
booleansleepTime
intcheckHealth
booleanmaxAttempts
int$class: 'ActionHubPlugin'$class: 'AddTestToSetStep'domain
Stringproject
StringtestPlanPath
StringtestSetPath
String$class: 'AmxEclipseAntBuilder'targets
Stringname
Jenkins supplies some environment variables that can be used from within the build script.
StringantOpts
StringbuildFile
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
StringamxEclipseAntTra
StringbusinessStudioWs
Stringanchorename
StringanchoreioPass (optional)
StringanchoreioUser (optional)
Stringannotations (optional)
key
Stringvalue
StringautoSubscribeTagUpdates (optional)
booleanbailOnFail (optional)
booleanbailOnPluginFail (optional)
booleanbailOnWarn (optional)
booleanbundleFileOverride (optional)
StringdoCleanup (optional)
booleanengineCredentialsId (optional)
StringengineRetries (optional)
Stringengineurl (optional)
Stringengineverify (optional)
booleanforceAnalyze (optional)
booleanglobalWhiteList (optional)
StringinputQueries (optional)
query
StringpolicyBundleId (optional)
StringpolicyEvalMethod (optional)
StringpolicyName (optional)
StringuseCachedBundle (optional)
booleanuserScripts (optional)
String$class: 'AnsibleAdHocCommandBuilder'hostPattern
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
Stringmodule
Stringcommand
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleansudo (optional)
booleansudoUser (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsiblePlaybookBuilder'playbook
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleanlimit (optional)
StringskippedTags (optional)
StringstartAtTask (optional)
Stringsudo (optional)
booleansudoUser (optional)
Stringtags (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsibleTower'towerServer (optional)
StringjobTemplate (optional)
StringjobType (optional)
StringextraVars (optional)
StringjobTags (optional)
StringskipJobTags (optional)
Stringlimit (optional)
Stringinventory (optional)
Stringcredential (optional)
Stringverbose (optional)
booleanimportTowerLogs (optional)
booleanremoveColor (optional)
booleantemplateType (optional)
StringimportWorkflowChildLogs (optional)
boolean$class: 'AnsibleVaultBuilder'action (optional)
StringansibleName (optional)
Stringcontent (optional)
Stringinput (optional)
StringnewVaultCredentialsId (optional)
Stringoutput (optional)
StringvaultCredentialsId (optional)
StringantJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'AntExec'scriptSource
StringextendedScriptSource
StringscriptName
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
StringantName
StringantOpts
StringkeepBuildfile
booleanverbose
booleanemacs
booleannoAntcontrib
Disabling usage of Ant-Contrib Tasks in this build step.
booleanantwsJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'ApiFortressBuilder'mode
Stringhook
Stringid
Stringblocking
booleandryrun
booleansilent
booleanparam1name
Stringparam1value
Stringparam2name
Stringparam2value
Stringparam3name
Stringparam3value
String$class: 'AppClone'apiKey
StringappName
StringtemplateAppName
Stringappscanscanner
dynamic_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
Stringoptimization (optional)
StringpresenceId (optional)
StringscanFile (optional)
StringscanType (optional)
StringtestPolicy (optional)
Stringmobile_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
StringpresenceId (optional)
Stringstatic_analyzertarget
StringhasOptions
booleanopenSourceOnly (optional)
booleanname
Stringtype
Stringapplication
Stringcredentials
Stringemail (optional)
booleanfailBuild (optional)
booleanfailBuildNonCompliance (optional)
booleanfailureConditions (optional)
failureType
Stringthreshold
inttarget (optional)
Stringwait (optional)
boolean$class: 'AppScanSourceBuilder'disableScan
booleanapplicationFile
StringacceptSSL
booleancustomScanWorkspace
This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.
If this field is blank, the default scan directory will be used.
The default directory is this job's build folder, as defined by Jenkins.
Stringinstallation (optional)
String$class: 'AppScanStandardBuilder'startingURL
Spiders will find the remaining URLs in the domain to be included for scanning.
Stringinstallation
StringadditionalCommands (optional)
AppScanCMD exec|ex|e
Parameters:
[ /dest_scan|/dest|/d ]
[ /base_scan|/base|/b ]
[ /old_host|/ohost|/oh ]
[ /new_host|/nhost|/nh ]
[ /scan_template|/stemplate|/st ]
[ /login_file|/lfile|/lf ]
[ /multi_step_file|/mstepfile|/mf ]
[ /manual_explore_file|/mexplorefile|/mef ]
[ /policy_file|/pfile|/pf ]
[ /additional_domains|/adomains|/ad ]
[ /report_file|/rf ]
[ /report_type|/rt {xml} ]
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
[ /scan_log|/sl {false} ]
[ /explore_only|/eo {false} ]
[ /test_only|/to {false} ]
[ /multi_step|/mstep|/ms {false} ]
[ /continue|/c {false} ]
[ /merge_manual_explore_requests|/mmer {false} ]
[ /include_responses|/ir {false} ]
[ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ]
Creates new scan with base_scan's configuration
saving dest_scan and creating report, if configured.
AppScanCMD report|rep|r
Parametrs:
/base_scan|/base|/b
/report_file|/rf
/report_type|/rt
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
Creates a report for base_scan.
AppScanCMD close_proxy|cprxy|cpr
Closes AppScan proxy if was previously opened.
More info. at:
(9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315
http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
StringauthScan (optional)
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
booleanauthScanPw (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringauthScanRadio (optional)
A login sequence may be recorded using AppScan Standard's GUI by following these steps:
"Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
booleanauthScanUser (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringgenerateReport (optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
booleanhtmlReport (optional)
booleanincludeURLS (optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
StringpathRecordedLoginSequence (optional)
StringpdfReport (optional)
booleanpolicyFile (optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
StringreportName (optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
Stringverbose (optional)
booleanxooaname
StringappId
String$class: 'AppUploaderBuilder'buildFilePath
StringapplatixaxUrl
StringaxUsername
StringaxPassword
StringaxServiceTemplateName
StringaxServiceTemplateRepository
StringaxServiceTemplateBranch
StringaxServiceTemplateParameters
key
Stringvalue
String$class: 'ApprendaBuilder'appAlias
StringappName
StringversionAlias
Stringstage
StringartifactName
StringcredentialsId
Stringprefix
StringadvVersionAliasToBeForced
StringadvancedNewVersionOption
StringcustomPackageDirectory
StringapplicationPackageURL
StringarchiveUploadMethod
StringbuildWithParameters
booleanaqualocationType
Stringregistry
Stringregister
booleanlocalImage
StringhostedImage
StringonDisallowed
StringnotCompliesCmd
StringhideBase
booleanshowNegligible
booleanpolicies
StringcustomFlags
StringaquaMicroscannerimageName
StringonDisallowed
StringnotCompliesCmd
StringoutputFormat
StringaquaServerlessScanneronDisallowed
StringnotCompliesCmd
StringcodeScanPath
StringcustomFlags
StringarachniScannerurl
Stringchecks
Stringscope
pageLimit
intexcludePathPattern
StringuserConfig
filename
Stringformat
String$class: 'ArtifactPromotionBuilder'groupId
StringartifactId
Stringclassifier
Stringversion
Stringextension
StringstagingRepository
StringstagingUser
StringstagingPW
StringreleaseUser
StringreleasePW
StringreleaseRepository
StringpromoterClass
Stringdebug
booleanskipDeletion
'Skip deletion' option preserves the files in the staging repository.
Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.
booleanartifactResolver Define the artifacts you would like to download.
The target directory defines where the artifacts should be copied to. The coordinates are as you know it from maven or ivy:
artifacts
groupId
StringartifactId
Stringversion
Stringclassifier (optional)
Stringextension (optional)
StringtargetFileName (optional)
StringenableRepoLogging (optional)
booleanfailOnError (optional)
booleanreleaseChecksumPolicy (optional)
StringreleaseUpdatePolicy (optional)
StringsnapshotChecksumPolicy (optional)
StringsnapshotUpdatePolicy (optional)
StringtargetDirectory (optional)
String$class: 'ArtifactsUploadBuilder'projectName
Stringparameters
Stringselector
$class: 'ParameterizedBuildSelector'parameterName
String$class: 'PermalinkBuildSelector'id
String$class: 'SavedBuildSelector'$class: 'SpecificBuildSelector'buildNumber
String$class: 'StatusBuildSelector'stableOnly
boolean$class: 'TriggeredBuildSelector'fallback
boolean$class: 'WorkspaceSelector'filter
Stringtarget
Stringflatten
booleanoptional
booleanfingerprintArtifacts
booleanautoMedia
Type or select the item path in the media repository.
A path without an extension would be considered a folder into which the file/s will be uploaded.
If you specify a path of a file, that would be the name of the uploaded file in the repository.
StringassertthatBddFeaturesprojectId
StringcredentialsId
StringoutputFolder
Stringjql
Stringmode
String$class: 'AssetBuilder'name
Stringdescription
Stringversion
Stringvendor
Stringplatform
Stringarchitecture
Stringbits
Stringcpu
intmemory
intstorage
intinstallationScriptFilePath
StringmediaFilePaths
path
StringlicenseFilePath
StringdocumentationFilePath
StringassociateTagnexusInstanceId
StringtagName
Stringsearch
key
Stringvalue
String$class: 'AstreeBuilder'dax_file
Stringanalysis_id
Stringoutput_dir
Stringskip_analysis
booleangenXMLOverview
booleangenXMLCoverage
booleangenXMLAlarmsByOccurence
booleangenXMLAlarmsByCategory
booleangenXMLAlarmsByFile
booleangenXMLRulechecks
booleandropAnalysis
booleangenPreprocessOutput
booleanfailonswitch
failon
String$class: 'AutEnvironmentBuilder'autEnvironmentModel
almServerName
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringclientType
StringautEnvironmentId
StringuseExistingAutEnvConf
booleanexistingAutEnvConfId
StringcreateNewAutEnvConf
booleannewAutEnvConfName
StringautEnvironmentParameters
name
Stringvalue
StringparamType
StringshouldGetOnlyFirstValueFromJson
booleanpathToJsonFile
StringoutputParameter
String$class: 'AutoConfigBuilder'name
StringdiscobitUrl
StringdiscobitUser
StringdiscobitPassword
hudson.util.Secret
configurations
Stringcuuid
String$class: 'AwsBatchBuilder'jobname
Stringjobdefinition
Stringcommand
Stringjobqueue
Stringvcpu
Stringmemory
Stringretries
StringazureCLIprincipalCredentialId
Stringcommands
script
StringexportVariablesString
StringazureDownloadstorageCredentialId
StringdownloadType
StringbuildSelector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacecontainerName (optional)
StringdeleteFromAzureAfterDownload (optional)
booleandownloadDirLoc (optional)
StringexcludeFilesPattern (optional)
StringfileShare (optional)
StringflattenDirectories (optional)
booleanincludeArchiveZips (optional)
booleanincludeFilesPattern (optional)
StringprojectName (optional)
String$class: 'BDSBuilder'projectFile
Stringswitches
StringinstallationName
String$class: 'BapFtpBuilder'publishers
configName
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringasciiMode
Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.
Use with ASCII text files to fix the line terminators when transferring between different operating systems.
booleanremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
Select to delete all files and directories within the remote directory before transferring files.
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleanftpRetry
If publishing to this server fails, try again.
Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
retries
intretryDelay
longftpLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringftpCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
username
Stringpassword
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'BapSshBuilderPlugin'publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
booleanpatternSeparator
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
StringexecCommand (optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
StringexecTimeout (optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
intusePty (optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in
to a real tty. When this flag is set, sudo can only be
run from a login session and not via other means such
as cron(8) or cgi-bin scripts. This flag is off by
default.
booleanuseAgentForwarding (optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file.
Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
booleanuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleansshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
intretryDelay
longsshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringsshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
StringencryptedPassphrase
Key or
Path to key is configured.
Stringkey
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key.
StringkeyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key box.
The Path to key can be absolute, or relative to $JENKINS_HOME
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
StringbatchFilecommand
String$class: 'BeakerBuilder'jobSource
$class: 'FileJobSource'jobPath
String$class: 'StringJobSource'jobContent
StringdownloadFiles
booleanbenchmarkfilepath
String$class: 'BitbucketPublisher'serverUrl (optional)
StringcredentialsId (optional)
StringprojectKey (optional)
StringcreateProject (optional)
projectName
StringprojectUsers
StringprojectGroups
StringcreateJenkinsJobs (optional)
ciServer
StringprojectName (optional)
String$class: 'BlueprintLaunch'projectName
Project selection is mandatory.
StringblueprintName
Blueprint selection is mandatory.
StringapplicationName
Application Name is mandatory.
This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.
StringappProfileName
Application Profile selection is mandatory.
StringactionName
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringwaitForSuccessFulLaunch
booleanblueprintDescription
Description is fetched from the selected Calm blueprint
String$class: 'BootPluginBuilder'tasks
StringjvmOpts
String$class: 'BranchDestructionStep'project
Stringbranch
String$class: 'BranchGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
String$class: 'BuildBuilder'dbFolder
value
vcsroot, subfolder, scaprojectsubfolder
StringprojectPath
Stringpackageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
Stringoptions
Stringfilter
StringpackageVersion
StringdlmDashboard
dlmDashboardHost
StringdlmDashboardPort
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringbuildDescriptiondescriptionTemplate
StringbuildNamenameTemplate
String$class: 'BuildNameUpdater'fromFile
booleanbuildName
StringfromMacro
booleanmacroTemplate
StringmacroFirst
booleancrxBuildpackageId (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
Stringdownload (optional)
booleanlocalDirectory (optional)
StringrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longwspFilter (optional)
/etc # define /etc as the filter root
+/etc(/.*)? # include everything under /etc
-/etc/packages(/.)? # exclude package paths
To create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:
/content/acme # include the site content
/apps/acme # include the app code
This field supports parameter tokens.
String$class: 'BuildScanner'profile
Stringtarget
StringrepTemp
Stringthreat
StringstopScan
boolean$class: 'BuildStepBuilder'sourceFolderMode
Stringsubfolder
StringpackageId
StringserverType
Stringserver
StringauthenticationType
StringuserName
Stringpassword
hudson.util.Secret
database
StringcompareOptions (optional)
String$class: 'BuildStepWithTimeout'buildStep
$class: 'BuildStepsFromJsonBuilder'$class: 'BuildoutBuilder'pythonName
StringbuildoutCfg
Stringnature
Stringcommand
StringignoreExitCode
booleanbyteguardGreettoken
Stringtask_id
String$class: 'CFLaunchBuilder'cfComposition
StringsetCFVars
vars
Variable
StringValue
String$class: 'CFLintBuilder'folder
StringcflintFolder
StringcflintExcludesFile
StringotherArgs
String$class: 'CIMessageBuilder'providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CIMessageSubscriberBuilder'Subscribe to the CI message bus and wait for a message matching the specified JMS selector.
The variable value specifies the name of an environment variable in which to place the received message body.
The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CToolBuilder'cmake -P <script file>) or command mode (
cmake -E <command>).
installationName
Stringarguments (optional)
StringignoredExitCodes (optional)
StringtoolId (optional)
StringworkingDir (optional)
StringgenerateCachecaches
type
A2L, ELF, BUS, MODEL, SERVICEfilePath
StringdbChannel
Stringclear
boolean$class: 'CallOtherJenkinsBuilder'hostName
StringjobName
Stringspan
Stringretry
StringuserName
Stringpassword
Stringparameters
String$class: 'CaptureIOSDeviceScreenshot'url
StringcloudTestServerID
StringadditionalOptions
StringcastechoinstallationName
StringsourcePath
StringapplicationName
StringdisplayLog (optional)
booleanlogPath (optional)
StringoutputPath (optional)
StringqualityGate (optional)
StringchangeAsmVerversionPattern
StringassemblyCompany (optional)
StringassemblyCopyright (optional)
StringassemblyCulture (optional)
StringassemblyDescription (optional)
StringassemblyFile (optional)
StringassemblyProduct (optional)
StringassemblyTitle (optional)
StringassemblyTrademark (optional)
StringregexPattern (optional)
StringreplacementPattern (optional)
String$class: 'ChangesetEvaluator'basePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
StringdropAll (optional)
booleanlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringtagOnSuccessfulBuild (optional)
booleantestRollbacks (optional)
booleanurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
StringchatterPost postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId
If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
See Identity Confirmation in the salesforce.com online help for more information.
Stringbody
StringbuildUrlTitle (optional)
StringrecordId (optional)
Stringserver (optional)
String$class: 'CheckGateBuilder'project
Stringgate
String$class: 'ChefBuilderConfiguration'url
Stringsinatraurl
Stringfilter
Stringusername
Stringport
intcommand
Stringprivatekey
Stringparallel
booleanfail
booleanchlAtuoActioncontent
StringbrowserString
StringrunScriptOnly
booleanrootPath
StringlibPath
String$class: 'ChrootBuilder'chrootName
StringignoreExit
booleanadditionalPackages
StringpackagesFile
Stringclear
booleancommand
StringloginAsRoot
booleannoUpdate
booleanforceInstall
boolean$class: 'CifsBuilderPlugin'publishers
configName
Stringverbose
booleantransfers
sourceFiles
Stringexcludes
StringremoteDirectory
StringremovePrefix
StringremoteDirectorySDF
booleanflatten
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
booleanpatternSeparator
StringuseWorkspaceInPromotion
booleanusePromotionTimestamp
booleanretry
retries
intretryDelay
longlabel
label
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'ClangScanBuildBuilder'target
StringtargetSdk
xcodebuild -showsdks
Stringconfig
StringclangInstallationName
StringxcodeProjectSubPath
Stringworkspace
Stringscheme
Stringscanbuildargs
Stringxcodebuildargs
StringoutputFolderName
StringgoogleStorageUploadcredentialsId
Stringbucket
Stringpattern
StringpathPrefix (optional)
StringsharedPublicly (optional)
booleanshowInline (optional)
booleanexamCleanTarget$class: 'ClifBuilder'clifName
StringclifOpts
StringtestPlanFile
StringreportDir
String$class: 'CloudBuildBuilder'input
credentialsId
Stringrequest
filefilename
Stringinlinerequest
Stringsource (optional)
localpath
.tgz or .tar.gz) or zip file (.zip), or .tgz) and uploaded to a temporary Cloud Storage bucket. Stringrepobranch (optional)
Stringcommit (optional)
StringprojectId (optional)
StringrepoName (optional)
Stringtag (optional)
Stringstoragebucket
Stringobject
StringsubstitutionList (optional)
items
key
_) and use only numbers, uppercase letters, and underscores (respecting the regular expression
_[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see
Build Requests - User-defined substitutions.
Stringvalue
Stringsubstitutions (optional)
java.lang.String>
$class: 'CloudFormationBuildStep'stacks
stackName
Name of the stack. The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters. You can pass Environment Variables into this field.
Stringdescription
StringcloudFormationRecipe
Stringparameters
The parameters to pass into the recipe. A comma separated list of key/value pairs. ie: key1=value1,key2=value2
You can pass environment variables as values to a stack parameters.
Stringtimeout
longawsAccessKey
StringawsSecretKey
StringawsRegion
US_East_Northern_Virginia, US_WEST_Oregon, US_WEST_Northern_California, EU_Ireland, EU_Frankfurt, Asia_Pacific_Singapore, Asia_Pacific_Sydney, Asia_Pacific_Tokyo, South_America_Sao_Paulosleep
longpushToCloudFoundrytarget
Stringorganization
StringcloudSpace
StringcredentialsId
StringmanifestChoice (optional)
appName (optional)
StringappPath (optional)
Stringbuildpack (optional)
Stringcommand (optional)
Stringdomain (optional)
StringenvVars (optional)
key
Stringvalue
Stringhostname (optional)
Stringinstances (optional)
StringmanifestFile (optional)
Stringmemory (optional)
StringnoRoute (optional)
StringservicesNames (optional)
name
Stringstack (optional)
Stringtimeout (optional)
Stringvalue (optional)
StringpluginTimeout (optional)
StringselfSigned (optional)
StringservicesToCreate (optional)
name
Stringtype
Stringplan
StringresetService (optional)
boolean$class: 'CloudShellConfig'buildStep
$class: 'StartSandbox'blueprintName
StringsandboxDuration
StringmaxWaitForSandboxAvailability
intsetupTimeout
intparams (optional)
StringsandboxDomain (optional)
StringsandboxName (optional)
String$class: 'CmakeBuilder'cmake -G with the given options.
CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
installationName
StringbuildDir (optional)
StringbuildType (optional)
StringcleanBuild (optional)
booleancmakeArgs (optional)
Stringgenerator (optional)
StringpreloadScript (optional)
StringsourceDir (optional)
Stringsteps (optional)
args (optional)
cmake (separated by spaces). Arguments may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
DESTDIR=${WORKSPACE}/artifacts all install here to instruct the tool to copy the artifacts to
DESTDIR. At least the
make and the
ninja tool allow overriding the installation directory that way.
StringenvVars (optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
Please note that macros (e.g. ${WORKSPACE}) will not be resolved by a pipeline script.
StringwithCmake (optional)
$CMAKE_BUILD_TOOL) or to have
cmake run the build tool (by invoking
cmake --build <dir>).
boolean$class: 'CocoaPodsBuilder'cleanpods
boolean$class: 'CodeAnalysisBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringobjects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringowner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringtype
StringobjectFolders
path
The path of the directory to use to analyse files. Please note that this is relative to the machine running the job.
Stringfilter
Stringrecurse
booleanreport
name
The base name of the reports, without an extension. If empty no reports will be generated.
Stringhtml
booleanjson
booleanxls
booleanxml
booleanruleSet
intfailConditions
halstead
Halstead level which will cause the code analysis to fail, exclude to ignore.
intmaintainability
Maintainability index level which will cause the code analysis to fail, exclude to ignore.
intmcCabe
McCabes level which will cause the code analysis to fail, exclude to ignore.
intTCR
Toad Code Rating level which will cause the code analysis to fail, exclude to ignore.
intruleViolations
If enabled, code analysis will fail on any violation for the selected rule set.
booleansyntaxErrors
If enabled, code analysis will fail on any syntax error.
booleanignoreWrappedPackages
If enabled, code analysis will fail when a wrapped package is found.
boolean$class: 'CodeBuilder'credentialsType
StringcredentialsId
StringproxyHost
StringproxyPort
StringawsAccessKey
StringawsSecretKey
hudson.util.Secret
awsSessionToken
Stringregion
StringprojectName
StringsourceVersion
StringsseAlgorithm
StringsourceControlType
StringlocalSourcePath
StringworkspaceSubdir
StringgitCloneDepthOverride
StringreportBuildStatusOverride
StringsecondarySourcesOverride
StringsecondarySourcesVersionOverride
StringartifactTypeOverride
StringartifactLocationOverride
StringartifactNameOverride
StringartifactNamespaceOverride
StringartifactPackagingOverride
StringartifactPathOverride
StringartifactEncryptionDisabledOverride
StringoverrideArtifactName
StringsecondaryArtifactsOverride
StringenvVariables
StringenvParameters
StringbuildSpecFile
StringbuildTimeoutOverride
StringsourceTypeOverride
StringsourceLocationOverride
StringenvironmentTypeOverride
StringimageOverride
StringcomputeTypeOverride
StringcacheTypeOverride
StringcacheLocationOverride
StringcloudWatchLogsStatusOverride
StringcloudWatchLogsGroupNameOverride
StringcloudWatchLogsStreamNameOverride
Strings3LogsStatusOverride
Strings3LogsLocationOverride
StringcertificateOverride
StringserviceRoleOverride
StringinsecureSslOverride
StringprivilegedModeOverride
StringcwlStreamingDisabled
StringexceptionFailureMode
String$class: 'CodeCoverageBuilder'connectionId
StringcredentialsId
StringanalysisPropertiesPath
StringanalysisProperties
String$class: 'CodeScanBuilder'projectKey
StringcommitOverride
Stringversion
StringemailReportTo
The list of user names in instance. Invalid usernames are skipped with a warning.
Setting the analysis mode to 'preview' will create a 'new issues' build report but will not update the database
StringanalysisMode
StringprojectBranch
Stringblocking
booleancodescenecredentialsId
StringdeltaAnalysisUrl
Stringrepository
StringanalyzeBranchDiff (optional)
booleananalyzeLatestIndividually (optional)
booleanbaseRevision (optional)
StringcouplingThresholdPercent (optional)
intfailOnDecliningCodeHealth (optional)
booleanfailOnFailedGoal (optional)
booleanletBuildPassOnFailedAnalysis (optional)
booleanmarkBuildAsUnstable (optional)
booleanriskThreshold (optional)
intuseBiomarkers (optional)
boolean$class: 'CodeStreamBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringpipelineName
StringwaitExec
booleanpipelineParams
value
Stringname
String$class: 'CodefreshPipelineBuilder'selectPipeline
cfPipeline
StringcfBranch
StringsetCFVars
vars
Variable
StringValue
String$class: 'CompareBuilder'outputFolder
Path to the folder in that should be used to store compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompareWithBaselineBuilder'outputFolder
Path to the folder in that should be used to store baseline compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompoundBuilder'$class: 'ConditionalBuilder'runCondition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringrunner
A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false.
$class: 'DontRun'$class: 'Fail'$class: 'Run'$class: 'RunUnstable'$class: 'Unstable'conditionalbuilders
$class: 'ConfigAdd'apiKey
StringappName
StringconfigVars
String$class: 'ConfigFileBuildStep'managedFiles
fileId
Name of the file.
StringreplaceTokens (optional)
Decides whether the token should be replaced using macro.
booleantargetLocation (optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
Stringvariable (optional)
Name of the variable which can be used as the reference for further configuration.
String$class: 'ConfluenceReleaseNotesPublisher'jiraCredentialsID
StringconfluenceCredentialsID
StringspaceKey
StringjqlFilter
StringpageTitle
StringparentPageTitle
String$class: 'ConsulBuilder'installationName
StringoperationList
$class: 'ConsulGetKV'valuePath
StringenvironmentVariableName
String$class: 'ConsulServiceDiscoveryOperation'serviceName
StringserviceTag
StringenvironmentVariableName
StringhealthStatus
StringaddPort
boolean$class: 'ConsulSetKV'valuePath
Stringvalue
StringconsulSettingsProfileName
String$class: 'ConsulKVBuilder'hostUrl
Stringkey
StringaclToken (optional)
StringapiUri (optional)
StringdebugMode (optional)
ENABLED, DISABLEDenvVarKey (optional)
StringignoreGlobalSettings (optional)
booleankeyValue (optional)
StringrequestMode (optional)
READ, WRITE, DELETEtimeoutConnection (optional)
inttimeoutResponse (optional)
intassessContainerImagefailOnPluginError (optional)
booleanimageId (optional)
StringnameRules (optional)
packageNameaction
Stringcontains
StringvulnerabilityCategoryaction
Stringcontains
StringvulnerabilityTitleaction
Stringcontains
StringvulnerablePackageNameaction
Stringcontains
StringthresholdRules (optional)
criticalVulnerabilitiesaction
Stringthreshold
StringcvssV2Scoreaction
Stringthreshold
StringexploitableVulnerabilitiesaction
Stringthreshold
StringvulnerabilitiesWithMalwareKitsaction
Stringthreshold
StringmoderateVulnerabilitiesaction
Stringthreshold
StringpackageRiskScoreaction
Stringthreshold
StringriskScoreaction
Stringthreshold
StringsevereVulnerabilitiesaction
Stringthreshold
StringtotalVulnerabilitiesaction
Stringthreshold
StringtreatWarningsAsErrors (optional)
booleanworkspaceDir (optional)
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
Stringconfigs
search
Stringreplace
StringmatchCount
int$class: 'ContinuousReleaseProperties'properties
java.lang.String>
$class: 'CoordinatorBuilder'executionPlan
org.jenkinsci.plugins.coordinator.model.TreeNode
$class: 'CopadoBuilder'stepName
StringwebhookUrl
Stringapi_key
Stringtimeout
intcopydstFile (optional)
StringkeepMeta (optional)
booleanrecursive (optional)
booleansrcFile (optional)
String$class: 'CreateBaselineBuilder'outputFile
Path to the file that should be used to store baseline.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating baseline. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'CreateFingerprint'Create Fingerprints of specified files during a build process
targets
String$class: 'CreatePackageBuilder'Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_PACKAGE_NUMBER environment variable.
The choice of using the build step or post build action to trigger a BuildMaster build will be largely dependent on how you import the build artifacts into BuildMaster:
If you have multiple Jenkins jobs all triggering a build for the same BuildMaster application check out the "Enable Deployable in BuildMaster" and "Copy Previous Build's Variables" options as a means to ensure that the new BuildMaster build picks up artifacts from only the Jenkins jobs that have build for its release.
applicationId (optional)
StringdeployToFirstStage (optional)
waitUntilDeploymentCompleted
booleanprintLogOnFailure (optional)
booleanenableReleaseDeployable (optional)
If the BuildMaster deployable that these artifacts are associated with are disabled by default for a release checking this option will enable the deployable for the release before triggering a build.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
deployableId
The id of the deployable to ensure is enabled in BuildMaster for the selected release. Defaults to the BUILDMASTER_DEPLOYABLE_ID variable populated by the "Select BuildMaster Application" action.
StringpackageNumber (optional)
The number that BuildMaster should use for the build. Defaults to the BUILDMASTER_PACKAGE_NUMBER variable populated by the "Select BuildMaster Application" action. Leave the field blank to have BuildMaster use it's own BuildNumber - the BUILDMASTER_PACKAGE_NUMBER will be set to the actual BuildMaster build number used in this instance.
If supplying a build number to BuildMaster and the build will fail with a BadRequest exception if an attempt is made to reuse a build number from a previous build. If this happens you will need to update the Jenkins build number to something greater than the latest BuildMaster build - there is a plugin to help with that: Next Build Number Plugin.
NOTE: to retain backwards compatibility BUILDMASTER_PACKAGE_NUMBER has not been updated to reflect the new naming standard from BuildMaster - this may change in a future release
StringpackageVariables (optional)
Set build level variables.
variables
Provide a list of variables to pass to BuildMaster.
StringpreserveVariables (optional)
If checked will gather the variables from the previous build and include them in the list of variables being passed in for this build, these will not override any variables being added in the Variables list below.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
booleanreleaseNumber (optional)
String$class: 'CreateSnapshotBuilder'outputFile
Path to the file that should be used to store snapshots.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
Folder/file location must be specified as:
StringcreateTagnexusInstanceId
StringtagName
StringtagAttributesJson (optional)
StringtagAttributesPath (optional)
String$class: 'CreateTemplate'cloud
Stringworkspace
StringinstanceTags
StringtemplateName
Stringprovider
Stringdatacenter
Stringfolder
Stringdatastore
StringclaimFilter
StringpolicyName
Stringclaims
String$class: 'CreateTunnelBuilder'srfTunnelName
String$class: 'CriticalBlockEnd'Release all resources that Critical block start had allocated for this job.
$class: 'CriticalBlockStart'Delimite the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
cryptomovename
Stringtoken
String$class: 'CucumberSlackBuildStepNotifier'channel
Stringjson
StringhideSuccessfulResults
boolean$class: 'CustomPythonBuilder'home
Stringnature
Stringcommand
StringignoreExitCode
boolean$class: 'CxScanBuilder'credentialsId
StringbuildStep
StringteamPath
StringsastEnabled
booleanexclusionsSetting
StringfailBuildOnNewResults
booleanfailBuildOnNewSeverity
StringosaArchiveIncludePatterns
StringosaInstallBeforeScan
booleanuseOwnServerCredentials (optional)
booleanserverUrl (optional)
Stringusername (optional)
Stringpassword (optional)
StringprojectName (optional)
StringprojectId (optional)
longgroupId (optional)
Stringpreset (optional)
StringjobStatusOnError (optional)
GLOBAL, FAILURE, UNSTABLEpresetSpecified (optional)
booleanexcludeFolders (optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
StringfilterPattern (optional)
Example: **/*.java, **/*.html, !**\test\**\XYZ*
Pattern Syntax
A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.separators at the beginning of the pattern and the string to match:
When a pattern starts with a File.separator, the string to match must also start with a File.separator. When a pattern does not start with a File.separator, the string to match may not start with a File.separator. When one of these rules is not obeyed, the string will not match.
When a name path segment is matched against a pattern path segment, the following special characters can be used:
'*' matches zero or more characters
'?' matches one character.
May reference build parameters like ${PARAM}.
Examples:
"**\*.class" matches all .class files/dirs in a directory tree.
"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test.
"**" matches everything in a directory tree.
"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
Stringincremental (optional)
booleanfullScansScheduled (optional)
booleanfullScanCycle (optional)
intsourceEncoding (optional)
Stringcomment (optional)
StringskipSCMTriggers (optional)
booleanwaitForResultsEnabled (optional)
booleanvulnerabilityThresholdEnabled (optional)
booleanhighThreshold (optional)
intmediumThreshold (optional)
intlowThreshold (optional)
intosaEnabled (optional)
booleanosaHighThreshold (optional)
intosaMediumThreshold (optional)
intosaLowThreshold (optional)
intgeneratePdfReport (optional)
booleanenableProjectPolicyEnforcement (optional)
booleanthresholdSettings (optional)
StringvulnerabilityThresholdResult (optional)
StringincludeOpenSourceFolders (optional)
Include/Exclude definition will not affect dependencies resolved from package manager manifest files.
Comma separated list of include or exclude wildcard patterns. Exclude patterns start with exclamation mark "!". Example: *.jar */folder/* */folder1/folder2/* */folder*/* */file.* */file*.jar */test/*file*.*
May reference build parameters like ${PARAM}.
Examples:
"**/*.jar" matches all .jar jars in a directory tree.
"*/test/a??.jar" matches all files/dirs which start with an 'a', then two more characters and then ".jar", in a directory called test.
"**" matches everything in a directory tree.
"**/test/**/XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc/test/def/ghi/XYZ123").
StringexcludeOpenSourceFolders (optional)
StringavoidDuplicateProjectScans (optional)
booleangenerateXmlReport (optional)
booleanthisBuildIncremental (optional)
booleanosfBuilderSuiteForSFCCDataImporthostname (optional)
StringbmCredentialsId (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringarchiveName (optional)
StringsourcePath (optional)
StringincludePatterns (optional)
includePattern
StringexcludePatterns (optional)
excludePattern
StringimportStrategy (optional)
StringtempDirectory (optional)
String$class: 'DatabaseDocBuilder'outputDirectory (optional)
StringbasePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
Stringurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
String$class: 'DaticalDBBuilder'daticalDBProjectDir
StringdaticalDBServer
StringdaticalDBAction
StringdaticalDBCmdProject
StringdaticalDBExportSQL
StringdaticalDBExportRollbackSQL
StringdaticalDBScriptDir
String$class: 'DebianPackageBuilder'pathToDebian
StringnextVersion
StringgenerateChangelog
booleansignPackage
booleanbuildEvenWhenThereAreNoChanges
booleandebianPbuilderadditionalBuildResults (optional)
When running a build in the chroot environment, there are occasionally files that you must retrieve from the chroot that are not part of the normal build. For example, some files that you may need to get back would include test results, auto-generated files, etc.
Set this variable in order to get the files back from the chroot build environment.
The files that are retrieved will also automatically be archived as well with the other build results.
This must be a comma-separated list; spaces are allowed.
Stringarchitecture (optional)
The architecture to build this as.
If the project is using the Matrix Build plugin, leave this blank (the architectures to build for are defined by the 'architecture' environment variable).
This is mostly to support Pipeline, however it can be used as a normal parameter as well.
StringbuildAsTag (optional)
Set this to mark this as building a tag. When a build comes from a tag, the deb version does not get incremented(i.e. it is exactly as set in the debian/changelog file). If using SVN, this plugin automatically looks at the SVN_URL_1 environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. If using Git, this plugin automatically looks at the GIT_BRANCH environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. Alternatively, you can also set the environment variable DEB_PBUILDER_BUILDING_TAG to either true or false.
booleancomponents (optional)
The components to build with. By default, pbuilder sets this to 'main'. If you're building an Ubuntu package, you may need to set this to "main restricted universe multiverse"
The setting guessComponents must be false for this setting to be honored.
StringdebianDirLocation (optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
Stringdistribution (optional)
The distribution to build for. By default, this checks the distribution that is set in debian/changelog. If the version in the changelog is UNRELEASED, it attempts to use the currently running distribution if this parameter is NULL or a 0-length string.
StringguessComponents (optional)
If set to true, automatically try to guess the components. This means that if we think we are building an Ubuntu package on Debian, our components will be automatically set to "main restricted universe multiverse"
booleankeyring (optional)
The keyring to build with. By default, we will attempt to figure out if we are building a Debian package on Ubuntu, and if we think that we are this will be set to /usr/share/keyrings/debian-archive-keyring.gpg. This file is part of the debian-archive-keyring package. If you need to use a custom keyring, put it in here. If for some reason the auto-detection is not working properly, set this to the string 'disabled' and no keyring settings for pbuilder will be set.
StringmirrorSite (optional)
The mirror site to use. If this is not set or a 0-length string, then the default mirror site for this distribution will be used. The default mirror site is defined in /etc/pbuilderrc
StringnumberCores (optional)
The number of cores to use when building. By default, this is 1. Set to -1 in order to use as many cores as possible when building. In order for this to take effect, you need to make sure that your debian/rules is setup properly. See this post.
intpristineTarName (optional)
If this field set, and if source/format indicates that this is a quilt package, we will attempt to checkout the given original tar file.
String$class: 'DeleteApplication'serverName
StringappName
Stringdomain
String$class: 'DeleteChartBuildStep'id
StringkubeName
Stringnamespace
StringchartsRepo
StringchartName
StringdeleteComponentsnexusInstanceId
StringtagName
String$class: 'DeleteEnvironmentBuilder'systemId
intenvironmentName
String$class: 'DeleteVirtualizeBuilder'serverType
StringserverHost
StringserverName
StringdependencyCheckadditionalArguments (optional)
StringodcInstallation (optional)
StringskipOnScmChange (optional)
booleanskipOnUpstreamChange (optional)
boolean$class: 'DeployApplication'This plugin creates a container on the OpenShift PaaS and deploys the application into the container.
serverName
StringappName
Stringcartridges
Specify a space delimited list of cartridges to be assigned to the application. e.g. jbosseap-6 mysql-5.5
Note that the specified cartridges need to be available on the selected OpenShift server. For a complete list of available cartridges on OpenShift refer to OpenShift web console or use the command line too 'rhc cartridges'. Here is the list of some of the most common cartridges:
Stringdomain
StringgearProfile
StringdeploymentPackage
In case of URL or when only one deployment package exists in the given directory, the package is deployed under the root ("/") context. When multiple packages are found, all are deployed under their own context paths.
Token macro expressions can be used for specifying a URL:
https://repo/nexus/service/local/artifact/maven/redirect?r=central&g=${ENV,var="GROUPID"}&a=${ENV,var="ARTIFACTID"}&v=${ENV, var="VERSION"}&e=war
Check Token Macro Plugin for further details.
StringenvironmentVariables
Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
StringautoScale
booleandeploymentType
GIT, BINARYopenshiftDirectory
String$class: 'DeployBox'id
Stringcloud
Stringworkspace
Stringbox
StringboxVersion
StringinstanceName
Stringprofile
Stringclaims
Stringprovider
Stringlocation
StringinstanceEnvVariable
Additional instance properties will also be available via other environment variables that have the defined variable as prefix of their name. For example, if INSTANCE is specified for this field then the following environment variables are available:
INSTANCE - ID of the deployed instance
INSTANCE_URL - URL of the deployed instance
INSTANCE_SERVICE_ID - service ID of the deployed instance
INSTANCE_TAGS - comma-separate list of tags of the deployed instance
If 1 is specified for Number of Instances then the following environment variables are available:
INSTANCE_MACHINE_NAME - VM name of the deployed instance
INSTANCE_PUBLIC_ADDRESS - VM public address of the deployed instance
INSTANCE_PRIVATE_ADDRESS - VM private address of the deployed instance
If Number of Instances is greater than 1, the following environment variable are available:
INSTANCE_MACHINE_NAMES - space-separate list of VM names
INSTANCE_PUBLIC_ADDRESSES - space-separate list of public addresses of the VMs
INSTANCE_PRIVATE_ADDRESSES - space-separate list of private addresses of the VMs
Stringtags
Stringvariables
Stringexpiration
$class: 'AlwaysOn'$class: 'ShutDown'hours
Stringdate
Stringtime
String$class: 'Terminate'hours
Stringdate
Stringtime
StringautoUpdates
StringalternateAction
StringwaitForCompletion
booleanwaitForCompletionTimeout
intboxDeploymentType
StringsamDeploysettings
credentialsId
Stringregion
Strings3Bucket
StringstackName
StringtemplateFile
template.yaml
app/template.json
StringkmsKeyId (optional)
StringoutputTemplateFile (optional)
template-#jobId.yaml by default.
Stringparameters (optional)
key
Stringvalue
StringroleArn (optional)
Strings3Prefix (optional)
Stringtags (optional)
key
Stringvalue
String$class: 'DeployChartBuildStep'id
StringkubeName
Stringnamespace
StringchartsRepo
StringchartName
StringdeleteChartWhenFinished
booleancrxDeploypackageIdFilters (optional)
**/*.zip
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zip
Matching packages will be uploaded in the order in which the filters are specified. Only the highest matching version of a package identified by 'group:name' will be deployed, and it will only be deployed once per build step, regardless of the number of matching filters.
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringacHandling (optional)
Stringautosave (optional)
intbehavior (optional)
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringdisableForJobTesting (optional)
booleanlocalDirectory (optional)
Stringrecursive (optional)
booleanreplicate (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
long$class: 'DeployPromotionBuilder'hosts
?>
$class: 'DeployScriptBuilder'out
Specify full path to target connection file.
File location must be specified as:
Stringin
Specify path to file that contains SQL script.
File location must be specified as:
StringbuildMasterDeployPackageToStageDeploys (or re-deploys) a build to a particular stage.
Note that when used in a pipeline step that the applicationdId, releaseNumber, and packageNumber fields are required:
buildMasterDeployPackageToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, packageNumber: BUILDMASTER_PACKAGE_NUMBER, waitTillBuildCompleted: [printLogOnFailure: true])
applicationId (optional)
This setting would only be altered if not using the "Select BuildMaster Application" action.
StringdeployVariables (optional)
Set deployment level variables.
variables
Provide a list of variables to pass to BuildMaster.
StringpackageNumber (optional)
The job will fail if there is no active BuildMaster release.
This setting would only be altered if not using the "Select BuildMaster Application" action.
StringprintLogOnFailure (optional)
booleanreleaseNumber (optional)
Stringstage (optional)
Optional. If not supplied, the next stage in the pipeline will be used.
StringwaitUntilDeploymentCompleted (optional)
boolean$class: 'Deployer'stack
StringdryRun
booleanbranch
StringapiKey
String$class: 'DeploymentBuilder'url
StringuserId
Stringpassword
StringenableZipFile
booleanenableAutoDeploy
booleanenableTestCase
testcaseblock
projectname
Stringtestcasename
Stringxpath
String$class: 'DescriptionSetterBuilder'This plugin automatically sets a description for the build as a step during building.
A description can be based on the log output (by searching it using a regular expression), or it can be hardcoded.
The description is exposed as DESCRIPTION_SETTER_DESCRIPTION environment variable
regexp
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
Stringdescription
StringdevSpacesCreateazureCredentialsId
StringaksName (optional)
StringkubeconfigId (optional)
StringresourceGroupName (optional)
StringsharedSpaceName (optional)
StringspaceName (optional)
StringsvDeployTestDeploys and starts CA DevTest test or test suite provided as a .mar file.
Throws exception if .mar file is incorrect, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringmarFilePath
StringtestType
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvDeployVirtualServiceDeploys and starts virtual service provided as a .mar file to target VSE. More services could be provided using comma or newline separator.
Throws exception if .mar file is incorrect, virtual service is already deployed, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringmarFilesPaths
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvStartVirtualServiceStarts virtual service that is already deployed on target VSE. More services could be started using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvStopVirtualServiceStops virtual service that is running on target VSE. More services could be stopped using comma or newline separator.
Throws exception if virtual service is not running on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvUndeployVirtualServiceUndeploys (removes) virtual service from specified VSE. More services could be provided using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleanimportDeveloperProfileprofileId
StringdeveloperProfileId (optional)
StringimportIntoExistingKeychain (optional)
booleankeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
hudson.util.Secret
$class: 'DiawiUploader'token
StringfileName
StringproxyHost
StringproxyPort
intproxyProtocol
String$class: 'DistTestingBuilder'The goal of this plugin is to enable a distributed testing of some compiled classes on multiple nodes. Tests are send one by one to nodes in the label specified for the project and run. Test results are saved in the "results" directory in the project workspace. f.e. "TEST-helloword.HelloTest.xml" for the test class "helloworld.HelloTest".
This plugin suppose that all slaves in the specified label have a shared workspace directory. (like NFS)
Only classes in the "Tests classes directory" directory with a file name containing a "test" substring (case insensitive) are automatically found by this plugin and run.
If you enable "Publish JUnit test result report" in the "Post-build Actions" section and type "results/*.xml" you will see test results in the Hudson's web UI.
Only nodes in a label which were specified for this project ("Tie this project to a node") will be used for distributed testing. This label must contain at least 2 nodes.
It's possible let this plugin to compile tests class sources which were checkout from a repository if "Compile tests" checkbox was checked. Remember to provide all necessary libraries needed for compilation.
It's possible to check a "Wait for nodes which are busy" checkbox to wait for other nodes which are busy to be freed.
distLocations
distDir
StringlibLocations
libDir
StringtestDir
This specifies a relative path in the project workspace where compiled tests resides. For example if tests are in build/test/classes then type "build/test/classes". In case you check "Compile tests" checkbox this relative path will be used for storing compiled tests classes which were before check-out from a repository.
StringwaitForNodes
Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
booleancompileTests
If checked then all source codes in the "Tests classes directory" will be compiled. It's necessary to provide all libraries for compilation. Compiled tests will be saved into the directory "tests".
boolean$class: 'DockerBuilderControl'option
$class: 'DockerBuilderControlOptionProvisionAndStart'cloudName
StringtemplateId
String$class: 'DockerBuilderControlOptionRun'cloudName
Stringimage
StringpullCredentialsId
StringdnsString
Stringnetwork
StringdockerCommand
StringvolumesString
StringvolumesFrom
StringenvironmentsString
Stringhostname
StringmemoryLimit
intmemorySwap
intcpuShares
intshmSize
intbindPorts
StringbindAllPorts
booleanprivileged
booleantty
booleanmacAddress
String$class: 'DockerBuilderControlOptionStart'cloudName
StringcontainerId
String$class: 'DockerBuilderControlOptionStop'cloudName
StringcontainerId
Stringremove
boolean$class: 'DockerBuilderControlOptionStopAll'remove
boolean$class: 'DockerBuilderNewTemplate'dockerTemplate
dockerTemplateBase
$class: 'DockerTemplateBase'image
StringbindAllPorts (optional)
booleanbindPorts (optional)
StringcpuShares (optional)
intdevicesString (optional)
StringdnsString (optional)
StringdockerCommand (optional)
StringenvironmentsString (optional)
Zero or more environment variables that are set within the docker container. This is a multi-line text field. Each line must be of the form key=value and specify one variable name and its value.
Note that quotes are not interpreted.
e.g. foo="bar" will result in the quotes being part of foo's value.
Note also that whitespace is easily broken. Editing this field this without first expanding the box to its multi-line form will cause any whitespace within a line to be turned into end of line codes, breaking up the line and thus changing its meaning.
e.g. The single setting:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
can be (accidentally) turned into three separate settings:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
thus preventing the configuration from working as was intended.
StringextraHostsString (optional)
Stringhostname (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
intmemorySwap (optional)
intnetwork (optional)
Stringprivileged (optional)
booleanpullCredentialsId (optional)
StringshmSize (optional)
inttty (optional)
booleanvolumesFromString (optional)
StringvolumesString (optional)
Stringconnector
For all connection methods, Jenkins will start by triggering a docker run. Then, after this step, there will optionally be more steps to establish the connection. There is currently three alternative ways to connect your Jenkins master to the dynamically provisioned Docker agents.
There are different pros and cons for each connection method. Depending on your environment, choose the one matching your needs. More detailed prerequisites are provided once you select a given method.
docker exec, all by using the Docker API. The agent does not need to be able to reach the master through the network layers to communicate ; all will go through Docker API.
docker run command with the right secret. And the remoting agent will establish the connection with the master through the network. Hence, the agent must be able to access the master through its address and port.
attachuser (optional)
StringjnlpjnlpLauncher
tunnel
Stringvmargs
StringentryPointArgumentsString (optional)
StringjenkinsUrl (optional)
Stringuser (optional)
StringsshsshKeyStrategy
$class: 'InjectSSHKey'user
String$class: 'ManuallyConfiguredSSHKey'credentialsId
StringsshHostKeyVerificationStrategy
$class: 'KnownHostsFileKeyVerificationStrategy'Checks the known_hosts file (~/.ssh/known_hosts) for the user Jenkins is executing under, to see if an entry exists that matches the current connection.
This method does not make any updates to the Known Hosts file, instead using the file as a read-only source and expecting someone with suitable access to the appropriate user account on the Jenkins master to update the file as required, potentially using the ssh hostname command to initiate a connection and update the file appropriately.
$class: 'ManuallyProvidedKeyVerificationStrategy'Checks the key provided by the remote host matches the key set by the user who configured this connection.
key
The SSH key expected for this connection. This key should be in the form `algorithm value` where algorithm is one of ssh-rsa or ssh-dss, and value is the Base 64 encoded content of the key.
String$class: 'ManuallyTrustedKeyVerificationStrategy'Checks the remote key matches the key currently marked as trusted for this host.
Depending on configuration, the key will be automatically trusted for the first connection, or an authorised user will be asked to approve the key. An authorised user will be required to approve any new key that gets presented by the remote host.
requireInitialManualTrust
Require a user with Computer.CONFIGURE permission to authorise the key presented during the first connection to this host before the connection will be allowed to be established.
If this option is not enabled then the key presented on first connection for this host will be automatically trusted and allowed for all subsequent connections without any manual intervention.
boolean$class: 'NonVerifyingKeyVerificationStrategy'Does not perform any verification of the SSH key presented by the remote host, allowing all connections regardless of the key they present.
javaPath (optional)
StringjvmOptions (optional)
StringlaunchTimeoutSeconds (optional)
intmaxNumRetries (optional)
intport (optional)
intprefixStartSlaveCmd (optional)
StringretryWaitTime (optional)
intsuffixStartSlaveCmd (optional)
StringlabelString
StringinstanceCapStr
The maximum number of containers, based on this template, that this provider is allowed to run in total.
Note that containers which have not been created by Jenkins are not included in this total.
A negative value, or zero, or 2147483647 all mean "no limit" is imposed on the this template, although the overall cloud instance limit (if any) will still apply.
Deprecated you should configure template with memory/cpu constraints, so docker infrastructure can manage resource consumption.
Stringdisabled (optional)
disabledByChoice (optional)
booleanenabledByChoice (optional)
Note: If problems are encountered then this functionality may be disabled automatically. If that happens then it will be shown here. In this situation, the disabled state is transient and will automatically clear after the stated period has elapsed.
booleanmode (optional)
NORMAL, EXCLUSIVEname (optional)
If blank or just whitespace, a default of "docker" will be used.
StringnodeProperties (optional)
hudson.slaves.NodeProperty>
pullStrategy (optional)
PULL_ALWAYS, PULL_LATEST, PULL_NEVERpullTimeout (optional)
Note: This overrides the read timeout specified for the cloud, but only for the docker pull operation (as this operation is expected to take longer than most docker operations).
intremoteFs (optional)
StringremoveVolumes (optional)
booleanretentionStrategy (optional)
Specify the strategy when docker containers shall be started and stopped:
idleMinutes
int$class: 'DockerBuilderPublisher'dockerFileDirectory
StringfromRegistry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringcloud
StringtagsString
StringpushOnSuccess
booleanpushCredentialsId
StringcleanImages
booleancleanupWithJenkinsJobDelete
boolean$class: 'DockerComposeBuilder'useCustomDockerComposeFile
booleandockerComposeFile
Stringoption
$class: 'ExecuteCommandInsideContainer'privilegedMode
booleanservice
Stringcommand
Stringindex
intworkDir
String$class: 'StartAllServices'$class: 'StartService'service
Stringscale
int$class: 'StopAllServices'$class: 'StopService'service
String$class: 'DockerPullImageBuilder'registry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringimage
StringdockerShellconnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intcontainerLifecycle (optional)
createContainer (optional)
bindAllPorts (optional)
booleanbindPorts (optional)
Stringcommand (optional)
StringcpuShares (optional)
intcpusetCpus (optional)
StringcpusetMems (optional)
StringdevicesString (optional)
StringdnsString (optional)
StringdockerLabelsString (optional)
Stringentrypoint (optional)
StringenvironmentString (optional)
StringextraHostsString (optional)
Stringhostname (optional)
StringlinksString (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
longnetworkMode (optional)
Stringprivileged (optional)
booleanrestartPolicy (optional)
policyName
NO, UNLESS_STOPPED, ALWAYS, ON_FAILUREmaximumRetryCount
intshmSize (optional)
longtty (optional)
booleanuser (optional)
StringvolumesFromString (optional)
StringvolumesString (optional)
Stringworkdir (optional)
Stringimage (optional)
StringpullImage (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intcredentialsId (optional)
StringpullStrategy (optional)
PULL_ALWAYS, PULL_ONCE, PULL_LATEST, PULL_NEVERregistriesCreds (optional)
registryAddr
StringcredentialsId
StringremoveContainer (optional)
force (optional)
booleanremoveVolumes (optional)
booleanstopContainer (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
inttimeout (optional)
intexecutorScript (optional)
StringlongConnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intshellScript (optional)
String$class: 'DoktorStep'server
StringmarkdownIncludePatterns
value
StringmarkdownExcludePatterns
value
StringasciidocIncludePatterns
value
StringasciidocExcludePatterns
value
String$class: 'DotNetCoreRunner'targetCode
//Simple Example
public class JenkinsPlugin
{
public static void ScriptMain()
{
Console.WriteLine("Hello World from c#!!!");
}
}
// Complete example
using DotNetTools.Jenkins;
using System;
public class JenkinsPlugin
{
public static void ScriptMain(JenkinsManager manager)
{
Console.WriteLine("Hello World from c#!!!");
manager.SetSessionEnv("PI", Math.PI.ToString());
}
}
public void SetSessionEnv(string key, string value);
public string GetSessionEnv(string key);
StringadditionalPackages
StringdownloadProgetPackageDownload options are:
See Inedo documentation.
feedName
StringgroupName
StringpackageName
Stringversion
StringdownloadFormat
StringdownloadFolder
If a full pathname is not supplied then the downloaded package 'should' end up in the workspace, but this is not guaranteed. If you wish the package to be placed in the workspace the it is best to use the Jenkins variable ${WORKSPACE}
StringcrxDownloadpackageIds (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanlocalDirectory (optional)
Stringrebuild (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longgoogleStorageDownloadcredentialsId
StringbucketUri
This specifies the cloud object to download from Cloud Storage. You can view these by visiting the "Cloud Storage" section of the Cloud Console for your project.
A single asterisk can be specified in the object path (not the bucket name), past the last "/". The asterisk behaves consistently with gsutil. For example, gs://my-bucket-name/pre/a_*.txt would match the objects in cloud bucket my-bucket-name that are named pre/a_2.txt or pre/a_abc23-4.txt, but not pre/a_2/log.txt.
StringlocalDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
StringpathPrefix (optional)
The specified prefix will be stripped from all downloaded filenames. Filenames that do not start with this prefix will not be modified. If this prefix does not have a trailing slash, it will be added automatically.
String$class: 'DoxygenBuilder'doxyfilePath
StringinstallationName
StringcontinueOnBuildFailure
booleanunstableIfWarnings
boolean$class: 'DrMemoryBuilder'executable
Stringarguments
StringlogPath
StringtreatFailed
boolean$class: 'DrupalInstanceBuilder'db
Stringroot
Stringprofile
Stringrefresh
If checked, every build will wipe out and recreate a fresh Drupal instance.
Note that creating a fresh Drupal instance sends an email to the site administrator (by default admin@example.net) which may be annoying.
booleanupdb
boolean$class: 'DrupalReviewBuilder'Review code using the Coder Review module.
If your code base does not include Coder, then Coder will be downloaded automatically.
style
booleancomment
booleansql
booleansecurity
booleani18n
booleanroot
Stringlogs
Stringexcept
Specify modules/themes that should not be reviewed, relative to the Drupal root directory.
For instance if you want to review only custom code then you might want to exclude contributed and core projects:
sites/all/modules/contrib/**,
sites/all/themes/contrib/**,
modules/**,
themes/**,
profiles/**
This field supports FileSet includes.
StringignoresPass
If checked, warnings flagged as ignored will pass.
Note that the ignore system was introduced in Coder 7.x-2.4. This option will be ignored if using an older version of Coder.
boolean$class: 'DrupalTestsBuilder'uri
Stringroot
Stringlogs
StringexceptGroups
Actions, Aggregator, AJAX, Batch API, Block, Blog, Book, Bootstrap, Cache, Color, Comment, Contact, Contextual, Dashboard, Database, DBLog, Entity API, Field API, Field types, Field UI, File, File API, File API (remote), Filter, Form API, Forum, Help, Image, Locale, Mail, Menu, Module, Node, OpenID, Pager, Path, Path API, PHP, Poll, Profile, RDF, Search, Session, Shortcut, SimpleTest, Statistics, Syslog, System, Taxonomy, Theme, Tracker, Translation, Trigger, Update, Update API, Upgrade path, User, XML-RPCMultiple groups can be separated by a comma.
StringexceptClasses
Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.
Multiple classes can be separated by a comma.
String$class: 'ECXCDMBuilder'name
Stringpassword
Stringurl
Stringjob
Stringproduction
booleanmaxWaitTime
int$class: 'EclipseBuckminsterBuilder'installationName
Stringcommands
StringlogLevel
Stringparams
StringtargetPlatformName
StringuserTemp
StringuserOutput
StringuserCommand
StringuserWorkspace
StringglobalPropertiesFile
StringequinoxLauncherArgs
StringazureIoTEdgeBuildazureCredentialsId (optional)
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringresourceGroup (optional)
StringrootPath (optional)
StringazureIoTEdgeDeployazureCredentialsId (optional)
StringresourceGroup (optional)
StringrootPath (optional)
In some cases, the Edge solution is not under the root of the code repository. You can specify path to the root of Edge solution in build definition. Example: If your code repository is an Edge solution, then leave it to default value './'. If your solution is under subfolder 'edge', then set it to 'edge'" Please notice that the module.json file path is relative to the root path of solution.
StringdeploymentFilePath (optional)
StringdeploymentId (optional)
Input the IoT Edge Deployment ID, if ID exists, it will be overridden.Lowercase letters, numbers and the following characters are allowed [ -:+%_#*?!(),=@;' ], no more than 128 characters. For more information: Visit docs
StringdeploymentType (optional)
StringdeviceId (optional)
StringiothubName (optional)
Stringpriority (optional)
Set the priority to a positive integer to resolve deployment conflicts: when targeted by multiple deployments a device will use the one with highest priority or (in case of two deployments with the same priority) latest creation time. For more information: Visit docs
StringtargetCondition (optional)
A target condition to determine which devices will be targeted with this deployment. Example tags.environment='test', properties.reported.devicemodel='4000x'
StringazureIoTEdgeGenConfigazureCredentialsId (optional)
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentFilePath (optional)
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringresourceGroup (optional)
StringrootPath (optional)
StringazureIoTEdgePushazureCredentialsId (optional)
StringresourceGroup (optional)
StringacrName (optional)
StringbypassModules (optional)
List of modules to bypass when building.
You can leave this field empty to build all modules
Or use comma delimited list of modules. Example "ModuleA,ModuleB"
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringdockerRegistryEndpoint (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdockerRegistryType (optional)
StringrootPath (optional)
String$class: 'ElasticsearchQueryBuilder'query
StringaboveOrBelow
Stringthreshold
longsince
longunits
String$class: 'EnvInjectBuilder'propertiesFilePath
StringpropertiesContent
String$class: 'EnvPropagatorBuilder'envVariableString
String$class: 'EnvironmentManagerBuilder'systemId
intenvironmentId
intinstanceId
intcopyToServer
booleannewEnvironmentName
StringserverType
StringserverId
intserverHost
StringserverName
StringcopyDataRepo
booleanrepoType
StringrepoHost
StringrepoPort
intrepoUsername
StringrepoPassword
StringabortOnFailure
boolean$class: 'EnvironmentTagBuilder'credentials
Stringregion
String$class: 'EstimateBuilder'name
Stringtoken
StringarchiveFilePath
StringregWhichIncludedModules
StringreportConfigName
Stringuri
Stringsaasuri
Stringlanguage
StringregexExclude
StringtestOnly
booleanmaxNumberOfViolations
longfailBlockTotalVio
booleanmaxNumberOfBlockerViolations
longfailBlockBlockerVio
booleanmaxNumberOfImportantViolations
longfailBlockImportantVio
booleanmaxNumberOfOptimizationViolations
longfailBlockOptimizationVio
booleanmaxNumberOfWarningViolations
longfailBlockWarningVio
booleanexamTest_ExecutionFileexamName
StringpythonName
StringexamReport
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringpathExecutionFile (optional)
StringpathPCode (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleanexamTest_ModelexamName
StringpythonName
StringexamReport
StringexecutionFile (optional)
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanexamModel (optional)
StringjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringmodelConfiguration (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
boolean$class: 'ExeBuilder'exeName
StringcmdLineArgs
StringfailBuild
booleanexecuteCerberusCampaigncampaignName
Stringenvironment
Stringbrowser
Stringscreenshot
Stringverbose
StringpageSource
StringseleniumLog
StringtimeOut
Stringretries
Stringpriority
Stringtag
Stringss_p
StringssIp
Stringrobot
StringmanualHost
StringmanualContextRoot
Stringcountry
StringcerberusUrl
StringtimeOutForCampaignExecution
intjobDsladditionalClasspath (optional)
StringadditionalParameters (optional)
java.lang.Object>
failOnMissingPlugin (optional)
booleanfailOnSeedCollision (optional)
booleanignoreExisting (optional)
booleanignoreMissingFiles (optional)
booleanlookupStrategy (optional)
JENKINS_ROOT, SEED_JOBremovedConfigFilesAction (optional)
IGNORE, DELETEremovedJobAction (optional)
IGNORE, DISABLE, DELETEremovedViewAction (optional)
IGNORE, DELETEsandbox (optional)
booleanscriptText (optional)
Stringtargets (optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
StringunstableOnDeprecation (optional)
booleanuseScriptText (optional)
boolean$class: 'ExecuteJobBuilder'jobId
longjobName
StringjobType
StringabortOnFailure
booleanpublish
booleanprojectId
longbuildId
StringsessionTag
StringappendEnv
boolean$class: 'ExecuteKatalonStudioTask'version
Stringlocation
StringexecuteArgs
Stringx11Display
StringxvfbConfiguration
StringexecManrequestType (optional)
StringaltEMConfig (optional)
url
Stringcredentials
Stringbookmark (optional)
name
Stringfolder (optional)
StringexecParams (optional)
list (optional)
key
Stringvalue
StringpostExecute (optional)
action
Stringparams
StringprocessList (optional)
database
Stringproject
Stringprocesses
processPath
Stringfolder
StringrequestName
Stringrequest (optional)
name
StringwaitConfig (optional)
pollInterval
StringmaxRunTime
String$class: 'ExecutorBuildStep'frameworkType
StringrunningType
Stringapp
StringtestApplication
StringdeviceQueries
Other field that can be used:
StringrunTags
StringexecutorOptions
maxDevices
Accepted value: [1..1000]. Default is 10
Set the maximum number of devices to allocate for this step execution.
Only applicable for Fast feedback mode.
intminDevices
Accepted value: [1..1000]. Default is 10
Set the minimum number of devices to allocate for this step execution.
Only applicable for Fast feedback mode.
intignoreTestsFile
StringoverallExecTimeout
intcreationTimeout
intexportIpaappURL (optional)
StringarchiveDir (optional)
Specify the location of the path (usually BUILD_DIR specified by xcodebuild) to read the Archive for exporting the IPA file.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringassetPackManifestURL (optional)
StringcompileBitcode (optional)
booleancopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
StringmanualSigning (optional)
booleanpackResourcesAsset (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresourcesAssetURL (optional)
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanxcodeName (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringexportPackagesexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExportParametersBuilder'filePath
StringfileFormat
StringkeyPattern
StringuseRegexp
booleanexportProjectsexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExporterBuilder'$class: 'ExtensiveTestingBuilder'testPath
Stringlogin
Stringpassword
StringserverUrl
StringprojectName
Stringdebug
booleandownloadFeatureFilesserverAddress
StringprojectKey
StringtargetPath
String$class: 'FigletBuilder'message
StringfileOperationsfileOperations
fileCopyOperationincludes
Stringexcludes
StringtargetLocation
StringflattenFiles
booleanfileCreateOperationfileName
StringfileContent
StringfileDeleteOperationincludes
Stringexcludes
StringfileDownloadOperationurl
StringuserName
Stringpassword
StringtargetLocation
StringtargetFileName
StringfileJoinOperationsourceFile
StringtargetFile
StringfilePropertiesToJsonOperationsourceFile
StringtargetFile
StringfileRenameOperationsource
Stringdestination
StringfileTransformOperationincludes
Stringexcludes
StringfileUnTarOperationfilePath
StringtargetLocation
StringisGZIP
booleanfileUnZipOperationfilePath
StringtargetLocation
StringfileZipOperationfolderPath
StringfolderCopyOperationsourceFolderPath
StringdestinationFolderPath
StringfolderCreateOperationfolderPath
StringfolderDeleteOperationfolderPath
StringfolderRenameOperationsource
Stringdestination
String$class: 'FireLineBuilder'fireLineTarget
csp
If you select "Yes", this plugin will set the following content of CSP to allow access to HTML with JS or CSS.
sandbox allow-scripts; default-src *; style-src * http://* 'unsafe-inline' 'unsafe-eval'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'
Warning:
There is a security risk if you select "Yes".
booleanblockBuild
If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
booleanconfiguration
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<fireline>
<args>
<!-- 序号对应的规则种类,用加号+相连
1:代码规范类
2:内存类
3:日志类
4:安全类
5:空指针
6:多线程
-->
<scanTypes>1+2+4+5+6</scanTypes>
<!--以上写法过滤了日志类的所有规则-->
<!--以下为过滤掉指定的单条规则,请加QQ群298228528获取规则名称-->
<filterRules>
<!--<filterRule ruleName="LogOnOffRule" />
<filterRule ruleName="LogBlockRule" />
<filterRule ruleName="LogAssignmentRule" />-->
</filterRules>
<!--过滤掉你不想检查的文件(注意:重复代码检查不支持过滤)-->
<filterFiles>
<!--过滤单个文件-->
<!--<filterFile Name="R.java"/>-->
<!--过滤整个文件夹-->
<!--<filterFile Name="/facebook/"/>-->
</filterFiles>
</args>
</fireline>
以上配置文件去掉了日志类的规则,所以火线扫描过程中就不会执行日志类规则的检查。
StringreportPath
StringreportFileName
StringbuildWithParameter
可通过配置使用build with parameter插件,在项目构建时灵活使用火线扫描。
例如:在项目配置中设置参数化构建参数。配置boolean类型参数fireline。
则在此输入框中填写${fireline}即可
Stringjdk
JDK to be used for this FireLine analysis.
Tips:
JDK1.7 or 1.8 is compatible with FireLine.
Stringjvm
合理设置JVM参数可以有效提高扫描效率,建议JVM最低配置如下:
"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
String$class: 'FitnesseBuilder'options
java.lang.String>
$class: 'FixResultBuilder'defaultResultName
Stringsuccess
Stringunstable
Stringfailure
Stringaborted
StringflywayrunnerinstallationName
StringflywayCommand
Stringurl
Stringlocations
StringcommandLineArgs
StringcredentialsId
String$class: 'FogbugzLinkBuilder'fortifyCloudScanbuildId
StringuseAutoHeap
booleanxmx
StringrmiWorkerMaxHeap
StringbuildLabel
StringbuildProject
StringbuildVersion
StringuseSsc
booleansscToken
StringupToken
StringversionId
StringscanArgs
Stringfilter
StringnoDefaultRules
booleandisableSourceRendering
booleandisableSnippets
booleanquick
booleanrules
StringuseParallelAnalysis
booleanfrugalTestinguserId
StringtestId
StringrunTag
StringgetJtl
booleanserverUrl (optional)
String$class: 'FtpRenameBuilder'ftpServer
StringftpPort
if you don't specify the port, the default port is 21.
intftpUser
StringftpPassword
hudson.util.Secret
ftpPath
Specify the path to your artifact.
StringartifactName (optional)
StringnewArtifactName (optional)
StringremoteDirectory (optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
String$class: 'FxCopBuilder'toolName
Stringfiles
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ file/directory ]
StringoutputXML
FxCop project or XML report output file.
Command Line Argument: /out:[ output file path ]
StringruleSet
Rule set to be used for the analysis.
Command Line Argument: /ruleset:=[ Rule set file path ]
StringignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleanforceOutput
Write output XML and project files even in the case where no violations occurred.
Command Line Argument: /forceoutput
booleancmdLineArgs
StringfailBuild
boolean$class: 'GCloudSDKBuilder'command
String$class: 'GCloudSDKWithAuthBuilder'credentialsId
Stringcommand
String$class: 'GatekeeperCommit'commitUsername
String$class: 'GatekeeperMerge'commitUsername
StringreleaseFilePath
StringreleaseFileContentTemplate
String$class: 'GatekeeperPush'genexusbgxInstallationId
StringkbPath
StringkbVersion
StringkbEnvironment
StringforceRebuild
boolean$class: 'GenerateChangeScriptBuilder'in
Specify path to input folder for generating SQL change script. This folder should contain result of previously executed "Run Compare" build step.
Folder location must be specified as:
Stringout
Path to the file that should be used to store SQL change script.
File location must be specified as:
String$class: 'GenerateCreateScriptBuilder'outputFile
Path to the file that should be used to store create SQL script.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'GenerateJenkinsReportBuilder'Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.
Warning: You can include only one Generate Jenkins HTML comparison report step per project.
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String$class: 'GenerateStandaloneReportBuilder'inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
StringoutputFolder
Specify path to folder where standalone report will be exported.
Folder location must be specified as:
StringgitAutomergerreleaseBranchPattern
StringmergeRules
path
Stringresolution
KEEP_OLDER, KEEP_NEWER, MERGE_OLDER_TOP, MERGE_NEWER_TOPlogLevel
TRACE, DEBUG, INFO, WARN, ERRORremoteName
StringcheckoutFromRemote
booleangitbisectjobToRun
StringgoodStartCommit
StringbadEndCommit
StringsearchIdentifier
StringrevisionParameterName
StringretryCount
intcontinuesBuild
booleanminSuccessfulIterations
intoverrideGitCommand
booleangitCommand
StringgitHubPRStatusstatusMessage
content
String$class: 'GitHubSetCommitStatusBuilder'contextSource (optional)
$class: 'DefaultCommitContextSource'$class: 'ManuallyEnteredCommitContextSource'context
StringstatusMessage (optional)
content
String$class: 'GitStatusWrapperBuilder'The gitStatusWrapper builder wraps set of job builders and handles PENDING/SUCCESS/FAILURE git statuses automatically
Check documentation here
buildSteps
$class: 'GnatmakeBuilder'gnatName
Stringswitches
StringfileNames
StringmodeSwitches
StringgprbuildinstallationName (optional)
Stringnames (optional)
Stringproj (optional)
-P switch. If not specified, GPRbuild uses the project file
default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
Stringswitches (optional)
StringgradlebuildFile (optional)
StringgradleName (optional)
StringmakeExecutable (optional)
booleanpassAllAsProjectProperties (optional)
booleanpassAllAsSystemProperties (optional)
booleanprojectProperties (optional)
StringrootBuildScriptDir (optional)
Stringswitches (optional)
StringsystemProperties (optional)
Stringtasks (optional)
StringuseWorkspaceAsHome (optional)
Gradle will write to $HOME/.gradle by default for GRADLE_USER_HOME. For a multi-executor slave in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
booleanuseWrapper (optional)
booleanwrapperLocation (optional)
String$class: 'Groovy'Executes a groovy script.
scriptSource
$class: 'FileScriptSource'scriptFile
String$class: 'StringScriptSource'command
StringgroovyName
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
Stringparameters
Parameters for the Groovy executable.
StringscriptParameters
These parameters will be passed to the script.
Stringproperties
Instead of passing properties using the -D parameter you can define them here.
StringjavaOpts
Direct access to JAVA_OPTS. Properties allows only -D properties, while sometimes also other properties like -XX need to be setup. It can be done here. This line is appended at the end of JAVA_OPTS string.
StringclassPath
Specify script classpath here. Each line is one class path item.
String$class: 'GroovyRemoteBuilder'remoteName
Stringscript
String$class: 'GsshCommandBuilder'disable
booleanserverInfo
Stringshell
String$class: 'GsshFtpDownloadBuilder'disable
booleanserverInfo
StringremoteFile
StringlocalFolder
StringfileName
String$class: 'GsshFtpUploadBuilder'disable
booleanserverInfo
StringlocalFilePath
StringremoteLocation
StringfileName
String$class: 'GsshShellBuilder'disable
booleanserverInfo
Stringshell
String$class: 'HOTPlayer'project
Stringbundle
com.arkea.jenkins.openstack.heat.orchestration.template.Bundle
habitattask (optional)
Stringdirectory (optional)
Stringartifact (optional)
Stringchannel (optional)
Stringorigin (optional)
StringbldrUrl (optional)
StringauthToken (optional)
StringlastBuildFile (optional)
Stringformat (optional)
StringsearchString (optional)
Stringcommand (optional)
Stringbinary (optional)
Stringpath (optional)
Stringdocker (optional)
booleanhealthAnalyzerproducts
$class: 'HealthAnalyzerLrStep'checkLrInstallation
booleancheckOsVersion
booleancheckFiles
filesList
field
String$class: 'HttpRequest'url
StringacceptType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMauthentication (optional)
StringconsoleLogResponseBody (optional)
booleancontentType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMcustomHeaders (optional)
name
Stringvalue
StringmaskValue
booleanhttpMode (optional)
GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCHhttpProxy (optional)
StringignoreSslErrors (optional)
booleanmultipartName (optional)
StringoutputFile (optional)
StringpassBuildParameters (optional)
booleanquiet (optional)
booleanrequestBody (optional)
Stringtimeout (optional)
intuploadFile (optional)
StringuseSystemProperties (optional)
booleanvalidResponseCodes (optional)
StringvalidResponseContent (optional)
StringhugobaseUrl (optional)
StringbuildFuture (optional)
booleandestination (optional)
Stringenvironment (optional)
StringhugoHome (optional)
Stringverbose (optional)
boolean$class: 'HyperBuilder'image
Stringcommands
String$class: 'ITest'workspace
Required.
(1) Provide the full path to the iTest workspace containing projects, or
(2) Leave blank to indicate that the current job's workspace is also an iTest workspace (must contain an .iTestWorkspace file as created by iTest)
Stringprojects
Required. Specify the name of the iTest project to export in an ITAR file (required to use iTestRT). Separate names of multiple projects with comma.
Note: The project must exist within the specified iTest workspace.
Stringtestcases
Required. Specify path to test case or test suite to run: must include extension (path/name.fftc or path/name.ffts). Separate multiple with a comma.
Accepted Formats:
project://projectname/path/to/testcase
/full/path/to/testcase
Examples:
project://system_test/regression_test.fftc
${WORKSPACE}/system_test/regression_test.fftc
Stringtestbed
Specify the URI of the testbed or topology to use for execution. Must include file extension. Overrides the testbed specified in the test case file.
Accepted Formats:
/path/to/topology.tbml
Examples:
${WORKSPACE}/system_test/topologies/demo.tbml
Stringparams
Specify a parameter value in the format parameter=value. Separate multiple parameter/value pairs with a comma.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument takes precedence over the values in the parameter file.
StringparamFile
Specify URI of a parameter file in an iTest readable format.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument take precedence over the values in the parameter file.
StringtestReportRequired
Check this to generate test report in HTML format.
A link to the report will be provided on the project page, and the report will be available in the iTest workspace specified in the project configuration page.
booleandbCustomTag
This option enables you to define and assign a value to a custom tag.
Example: Create a tag that holds the build number so that you compare test execution results between builds.
For tests run against build 54322, use: --tag buildNumber=54322
Tip: Use a custom tag to identify executions or groups of executions on the iTest Team Server Test Execution page.
String$class: 'ImportFiles'url
StringcloudTestServerID
Stringfiles
Stringexcludes
Stringmode
StringadditionalOptions
StringimportPackagesimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
StringimportProjectsimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'InfluxDBPublisher'userCredentialsID
StringdbUrl
StringdbName
Stringcontent
StringinfluxDbQuerycheckName
StringinfluxQuery
StringexpectedThreshold
doublemarkUnstable (optional)
booleanretryCount (optional)
intretryInterval (optional)
intshowResults (optional)
booleaninsightAppSecregion
StringinsightCredentialsId
StringappId
StringscanConfigId
StringbuildAdvanceIndicator
StringvulnerabilityQuery
vulnerability.severity='HIGH'
StringmaxScanPendingDuration
0d 5h 30m
StringmaxScanExecutionDuration
0d 5h 30m
StringenableScanResults
boolean$class: 'InstallBuilder'apkFile
StringuninstallFirst
booleanfailOnInstallFailure
boolean$class: 'IqPolicyEvaluatorBuildStep'iqStage
StringiqApplication
manualApplicationapplicationId
StringselectedApplicationapplicationId
StringiqScanPatterns
**/target/*.war or
**/target/*.ear. If unspecified, the scan will default to the patterns
**/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
scanPattern
StringiqModuleExcludes
**/nexus-iq/module.xml) to be ignored, e.g.
**/my-module/target/**, **/another-module/target/**. If unspecified all modules will contribute dependency information (if any) to the scan.
moduleExclude
StringfailBuildOnNetworkError
booleanjobCredentialsId
- none -, otherwise select different credentials.
StringadvancedProperties
key1=value1
key2=value2
String$class: 'IspwRestApiRequest'connectionId (optional)
StringconsoleLogResponseBody (optional)
booleancredentialsId (optional)
StringispwAction (optional)
StringispwRequestBody (optional)
StringskipWaitingForSet (optional)
boolean$class: 'IssueFieldUpdateStep'issueSelector (optional)
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'fieldId (optional)
StringfieldValue (optional)
String$class: 'IssueUpdatesBuilder'restAPIUrl
StringuserName
Stringpassword
Stringjql
StringworkflowActionName
Stringcomment
StringcustomFieldId
StringcustomFieldValue
StringresettingFixedVersions
booleancreateNonExistingFixedVersions
booleanfixedVersions
StringfailIfJqlFails
booleanfailIfNoIssuesReturned
booleanfailIfNoJiraConnection
boolean$class: 'JBossBuilder'operation
value
START_AND_WAIT, START, SHUTDOWN, CHECK_DEPLOYproperties
StringstopOnFailure
booleanserverName
String$class: 'JIRATicketEditor'jiraCredentialsID
StringnewTicketsTemplates
performDuplicateCheck
booleanparentJQL
Stringtitle
Stringtype
Stringpriority
Stringdescription
StringenvVarName
StringfieldValues
fieldHumanReadableName
StringvalueToSet
StringmodifyTicketsTemplates
jqlFilter
StringcommitRegEx
StringticketSource
Stringmodifications
$class: 'AddCommentModification'commentBody
String$class: 'ModifyArrayFieldModification'fieldHumanReadableName
StringmodificationType
StringmodificationValue
String$class: 'PerformTransitionModification'transitionName
Stringcomment
String$class: 'SetFieldModification'fieldHumanReadableName
StringvalueToSet
String$class: 'JIRAVersionEditor'jiraCredentialsID
StringversionModifiactions
versionName
StringreplaceDescription
booleandescriptionText
StringreleaseState
StringfailOnJQL
booleanfailQuery
String$class: 'JSLintBuilder'includePattern
The files to include in an Ant-style filter. See javadoc
Example: lib/**/*.js
This would grab files including lib/foo.js and lib/foo/bar/baz.js
Example: lib/*.js
This would include lib/foo.js but not lib/foo/bar.js
StringexcludePattern
The files to exclude in an Ant-style filter. See javadoc
Example: lib/**/ModuleImportProgressDialog.js
This would omit any file named ModuleImportProgressDialog.js
Stringlogfile
The file to output to in a Checkstyle XML format
Example: target/jslint.xml
Stringarguments
The arguments to pass to JSLint. You can use any arguments that JSLint supports! Be sure, though, to prefix each argument with -D
Example: -Dadsafe=true, -Dcontinue=true
This would activate adsafe and continue
Example: -Dpredef=foo,bar,baz
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on.
Example: -Dpredef=foo,bar,baz, -Dmaxlen=80
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on. It also sets the maximum length of a line to 80 chars.
The default options we use are:
var defaultOptions = { bitwise: true, eqeqeq: false, immed: false, newcap: false, nomen: false, onevar: false, plusplus: false, regexp: false, rhino: true, undef: true, white: false, forin: true, sub: true, browser: true, laxbreak: true, predef: [ 'Ext', 'jQuery', 'window', '$', 'ActiveXObject', 'SWFObject' ] };
String$class: 'JabberBuilder'builderName
String$class: 'JbpmUrlResourceBuilder'url
StringprocessId
StringSoapUIPropathToTestrunner
StringpathToProjectFile
Stringenvironment (optional)
StringprojectPassword (optional)
StringtestCase (optional)
StringtestSuite (optional)
String$class: 'JigomergeBuilder'source
Stringusername
Stringpassword
StringoneByOne
booleaneager
booleanvalidationScript
StringdryRun
booleanverbose
booleanignoreMergePatterns
StringcommitCommentPrefix
String$class: 'JiraEnvironmentVariableBuilder'Typical usage:
issue in (${JIRA_ISSUES})
issueSelector
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'$class: 'JiraExtBuildStep'issueStrategy
$class: 'FirstWordOfCommitStrategy'$class: 'FirstWordOfUpstreamCommitStrategy'$class: 'MentionedInCommitStrategy'$class: 'SingleTicketStrategy'issueKey
Stringextensions
$class: 'AddComment'postCommentForEveryCommit
booleancommentText
String$class: 'AddFixVersion'fixVersion
The Fix Version to append. Must exist.
String$class: 'AddLabel'labelName
String$class: 'AddLabelToField'fieldName
StringfieldValue
String$class: 'Transition'transitionName
String$class: 'UpdateField'fieldName
StringfieldValue
String$class: 'JiraIssueUpdateBuilder'jqlSearch
Example:
or (e.g., combined with a JIRA Issue Parameter, selecting one issue from a JQL result set):project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
issue = $ISSUE_ID
StringworkflowActionName
Stringcomment
String$class: 'JiraReleaseVersionUpdaterBuilder'jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in JIRA.
(EXAMPLE-100)
StringjiraRelease
StringjiraDescription
String$class: 'JiraVersionCreatorBuilder'jiraVersion
StringjiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in JIRA.
(EXAMPLE-100)
String$class: 'JobConfigRebrander'$class: 'JobDeleteBuilder'target
String$class: 'JobStrongAuthSimpleBuilder'jobUsers
StringuseGlobalUsers
booleanjobMinAuthUserNum
intuseJobExpireTime
booleanjobExpireTimeInHours
int$class: 'JobcopyBuilder'fromJobName
StringtoJobName
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
booleanadditionalFilesetList
includeFile
StringexcludeFile
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
boolean$class: 'KanboardTaskFetcher'projectIdentifier
StringtaskReference
StringtaskAttachments (optional)
StringtaskLinks (optional)
String$class: 'KarafBuildStepBuilder'useCustomKaraf
booleankarafHome
Stringflags
specify the port to connect to
-h [host]specify the host to connect to
-u [user]specify the user name
-p [password]specify the password (optional, if not provided, the password is prompted)
-vraise verbosity
-lset client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]retry connection establishment (up to attempts times)
-d [delay]intra-retry delay (defaults to 2 seconds)
-f [file]read commands from the specified file
-k [keyFile]specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]define the client idle timeout
Stringoption
$class: 'KarafCommandFileOption'file
String$class: 'KarafCommandScriptOption'script (optional)
StringunlockMacOSKeychainkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
hudson.util.Secret
$class: 'KloBuilder'kwinspectreportDeprecated
booleandeleteTable
booleanprojectName
StringbuildName
StringkloName
StringbuildUsing
StringkwCommand
If you have selected to build using a build command, enter the command that generates the file kwinject.out (the file that contains information used by Klocwork to build the report).
For Java project, you can use kwant command and for C/C++ project, you can use kwinject command.
For more information on those commands :
Quick start page
Kwant command and Building Java project with Klocwork
Kwinject command and Building C/C++ project with Klocwork
For C# projects, see the quick start and Kwcsprojparser command
Please do not use the --output option or the build will fail. If you need the output file, you can retrieve it in the workspace of your project. The file is called kwinject.out.
If you have selected to build using an existing build specification file, enter the full or relative path to that file.
StringkwbuildprojectOptions
StringcompilerBinaryBuild
booleankwBinaryBuild
booleanbuildLog
booleanparseLog
boolean$class: 'KlocworkBuildSpecBuilder'buildSpecConfig
buildCommand
Stringtool
Stringoutput
StringadditionalOpts
StringignoreErrors
boolean$class: 'KlocworkCiBuilder'ciConfig
buildSpec
StringprojectDir
StringcleanupProject
booleanreportFile
StringadditionalOpts
StringincrementalAnalysis
This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit like behaviour. The idea is that only changed files are analysed using the Klocwork kwciagent tool to replicate the analysis developers would perform using Visual Studio, Eclipse or the command line utility. To enable this the plugin takes a list of the changed files from the SCM, this enables the ability to analyse only the changed files when the workspace isn’t kept. Leave this unticked to analyse the whole project or if the workspace is kept then a standard incremental analysis.
The diff file list is the file to contain the changed source files that Klocwork should analyse. It is required that any analysed files should exist in the build specification generated by kwinject
IMPORTANT: It is required that any files to be analysed must also exist in the build specification specified
If using Git, please provide the previous commit that Git should perform a "diff" with. The change list between the current commit and the specified previous commit will then be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build.
If you are not using Git, or want to manually generate the change list using Git, then please select this option. You will need to generate the diff file list with a custom build-step (or similar). Future support for more SCM tools (such as SVN, perforce) may be added depending on demand. The format of the file should be a changed source file per line
Future support for more SCM tools (such as SVN, perforce) may be added depending on demand.
booleandiffAnalysisConfig
diffType
StringgitPreviousCommit
StringdiffFileList
StringciTool
String$class: 'KlocworkServerAnalysisBuilder'serverConfig
buildSpec
StringtablesDir
StringincrementalAnalysis
booleanignoreCompileErrors
booleanimportConfig
StringadditionalOpts
StringdisableKwdeploy
boolean$class: 'KlocworkServerLoadBuilder'serverConfig (optional)
tablesDir (optional)
StringbuildName (optional)
StringadditionalOpts (optional)
StringreportConfig (optional)
displayChart (optional)
booleanchartHeight (optional)
StringchartWidth (optional)
Stringquery (optional)
String$class: 'KlocworkXSyncBuilder'syncConfig
dryRun
booleanlastSync
StringprojectRegexp
StringstatusAnalyze
booleanstatusIgnore
booleanstatusNotAProblem
booleanstatusFix
booleanstatusFixInNextRelease
booleanstatusFixInLaterRelease
booleanstatusDefer
booleanstatusFilter
booleanadditionalOpts
String$class: 'KmapJenkinsBuilder'username
Stringpassword
StringkmapClient
Stringcategories
Stringteams
Stringusers
StringsendNotifications
booleanpublishOptional
teams
Stringusers
StringsendNotifications
booleanfilePath
StringappName
Stringbundle
Stringversion
Stringdescription
StringiconPath
String$class: 'KojiBuilder'kojiBuild
StringkojiTarget
StringkojiPackage
StringkojiOptions
StringkojiTask
StringkojiScratchBuild
booleankojiScmUrl
String$class: 'KubernetesDeploy'context
configs (optional)
The path patterns for the Kubernetes configurations you want to deploy, in the form of Ant glob syntax.
StringcredentialsType (optional)
Choose how to get the kubeconfig file to authenticate with the Kubernetes cluster management endpoint.
3 options are supported:
~/.kube/config file through an SSH connection to the master node.See also: Configure kubectl
StringdockerCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringenableConfigSubstitution (optional)
Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleankubeConfig (optional)
path (optional)
kubeconfig file path relative to the current Jenkins workspace.
StringkubeconfigId (optional)
StringsecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g.,
some-secret-$BUILD_NUMBER. The name should be in the pattern
[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See
Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
Stringssh (optional)
sshCredentialsId (optional)
StringsshServer (optional)
<host>[:<port>]) of the Kubernetes master node. If port is omitted, the default SSH port 22 will be used.
StringtextCredentials (optional)
certificateAuthorityData (optional)
clusters.cluster.certificate-authority-data value in the
kubeconfig file.
StringclientCertificateData (optional)
users.user.client-certificate-data value in the
kubeconfig file.
StringclientKeyData (optional)
users.user.client-key-data value in the
kubeconfig file.
StringserverUrl (optional)
clusters.cluster.server address in the
kubeconfig. Generally, it should start with
https://.
StringkubernetesEngineDeploycluster (optional)
StringclusterName (optional)
StringcredentialsId (optional)
Stringlocation (optional)
StringmanifestPattern (optional)
Stringnamespace (optional)
StringprojectId (optional)
StringverboseLogging (optional)
booleanverifyDeployments (optional)
booleanverifyServices (optional)
booleanverifyTimeoutInMinutes (optional)
intzone (optional)
Stringloadcompletetestproject (optional)
Stringtest (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleangeneratePDF (optional)
booleantimeout (optional)
StringuseTimeout (optional)
booleaneventSourceLambdalambdaEventSourceBuildStepVariables
awsRegion
StringfunctionName
StringeventSourceArn
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringfunctionAlias (optional)
StringuseInstanceCredentials (optional)
booleaninvokeLambdalambdaInvokeBuildStepVariables
awsRegion
StringfunctionName
Stringsynchronous
booleanawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringjsonParameters (optional)
envVarName
StringjsonPath (optional)
Stringpayload (optional)
StringuseInstanceCredentials (optional)
booleanpublishLambdalambdaPublishBuildStepVariables
awsRegion
StringfunctionARN
StringfunctionAlias
StringversionDescription
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringuseInstanceCredentials (optional)
booleandeployLambdalambdaUploadBuildStepVariables
awsRegion
StringfunctionName
StringupdateMode
Stringalias (optional)
StringartifactLocation (optional)
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringcreateAlias (optional)
booleandeadLetterQueueArn (optional)
Stringdescription (optional)
StringenableDeadLetterQueue (optional)
booleanenvironmentConfiguration (optional)
environment
key
Stringvalue
StringconfigureEnvironment (optional)
booleankmsArn (optional)
Stringhandler (optional)
StringmemorySize (optional)
Stringpublish (optional)
booleanrole (optional)
Stringruntime (optional)
StringsecurityGroups (optional)
Stringsubnets (optional)
Stringtimeout (optional)
StringuseInstanceCredentials (optional)
boolean$class: 'LeiningenBuilder'task
StringsubdirPath
String$class: 'LiterateBuilder'baseName
Stringenvironment
String$class: 'LoadImpactTestRunTask'apiTokenId
StringloadTestId
intcriteriaDelayValue
intcriteriaDelayUnit
StringcriteriaDelayQueueSize
intabortAtFailure
booleanthresholds
metric
Stringoperator
Stringvalue
intresult
StringpollInterval
intlogHttp
booleanlogJson
boolean$class: 'LoadNinjaBuilder'apiKey
StringscenarioId
Stringoeb
errorPassCriteria
Stringodb
durationPassCriteria
String$class: 'LoadPluginBuilder'url
Stringusername
Stringpassword
Stringfile
StringgreettestId
StringcredentialsId
String$class: 'LoadrunnerBuilder'path
StringtestPath
StringconnectQC
booleancredentials (optional)
Stringhost (optional)
StringqcDb (optional)
StringtestSetId (optional)
String$class: 'LoadtestBuilder'loadtestBuilderModel
environmentShortName
StringauthToken
StringpresetName
StringloadtestScenario
StringloadtestThresholdParameters
metricType
StringevaluationDirection
StringnumericValue
double$class: 'LoginBuilder'credentialsId
StringhubUrl
StringmablrestApiKey
StringenvironmentId
StringapplicationId
StringcontinueOnMablError (optional)
booleancontinueOnPlanFailure (optional)
booleandisableSslVerification (optional)
boolean$class: 'MailCommandBuilder'| POP3 mail server address | Set POP3 mail server's hostname or ip address. |
| POP3 mail server port | Set POP3 mail server's port. Default value is 110. |
| POP3 User Name | Set POP3 mail server's user account. |
| POP3 Password | Set POP3 mail server's password. |
address
Stringport
Stringusername
Stringpassword
String$class: 'MaintenanceMode'apiKey
StringappName
Stringmode
boolean$class: 'MakeAppTouchTestable'url
StringcloudTestServerID
StringinputType
StringprojectFile
Stringtarget
StringlaunchURL
StringbackupModifiedFiles
booleanadditionalOptions
StringjavaOptions
String$class: 'ManageInstance'cloud
Stringworkspace
Stringoperations
com.elasticbox.jenkins.builders.Operation
$class: 'MatlabBuilder'localMatlab (optional)
StringtestRunTypeList (optional)
$class: 'RunTestsAutomaticallyOption'taCoberturaChkBx (optional)
booleantaJunitChkBx (optional)
booleantatapChkBx (optional)
boolean$class: 'RunTestsWithCustomCommandOption'customMatlabCommand (optional)
Stringmaventargets
Stringname
Stringpom
Stringproperties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
StringjvmOptions
StringusePrivateRepository
booleansettings
settings.xml file contains elements used to define values which configure Maven execution in various ways, like the
pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml file per default may live:
$M2_HOME/conf/settings.xml${user.home}/.m2/settings.xml see also: settings.xml reference
standardfilePathpath
String$class: 'MvnSettingsProvider'settingsConfigId
StringglobalSettings
standard$class: 'FilePathGlobalSettingsProvider'path
String$class: 'MvnGlobalSettingsProvider'settingsConfigId
String$class: 'Maven3Builder'mavenName
StringrootPom
Stringgoals
StringmavenOpts
String$class: 'MavenDeploymentDownloader'projectName
StringfilePattern
.*)
StringpermaLink
StringtargetDir
StringstripVersion
booleanstripVersionPattern
StringfailIfNoArtifact
booleancleanTargetDir
booleanmavenSnapshotCheckcheck (optional)
boolean$class: 'MberDownloader'accessProfileName
Stringfiles
StringoverwriteExistingFiles
booleanuseTags
booleanshowProgress
booleanoptional
booleanattempts
int$class: 'MberUploader'accessProfileName
StringbuildArtifacts
StringartifactFolder
StringartifactTags
StringoverwriteExistingFiles
booleanlinkToLocalFiles
booleanshowProgress
booleanoptional
booleanattempts
int$class: 'MdtoolSolutionBuilder'installationName
StringsolutionPath
Stringtarget
value
Stringconfiguration
value
Stringproject
value
Stringruntime
value
String$class: 'MediaUploadBuilder'file2upload
Specify the path of the file relative to the workspace.
StringautoMedia
Type or select the repository item path.
A path without an extension would be considered a folder into which the file will be uploaded.
If you specify a path of a file, that would be the name of the uploaded file in the repository.
StringredmineMetricsReportsettings (optional)
url
StringapiKey
Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
StringprojectName
Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
StringcustomQueryId
intsprintSize
Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.
int$class: 'MicroDocsChecker'microDocsReportFile
StringmicroDocsProjectName
StringmicroDocsGroupName
StringmicroDocsEnvironments
StringmicroDocsSourceFolder
StringmicroDocsFailBuild
booleanmicroDocsPublish
booleanmicroDocsNotifyPullRequest
boolean$class: 'MobileStudioTestBuilder'mobileStudioRunnerPath
StringtestPath
StringmsgServer (optional)
StringdeviceId (optional)
StringprojectRoot (optional)
StringtestAsUnit (optional)
boolean$class: 'MockLoadBuilder'mock-artifact-*.txt. There will be a JUnit test report with the file name
mock-junit.xml. Approximately 5% of the time, the build will "fail" its tests and thus no artifacts will be generated.
averageDuration
long$class: 'ModelBuilder'pushGuardSettings
minBufferSize
StringhubUrls
String$class: 'MonitorRemoteJobBuilder'hostName
StringjobName
StringtimeBefore
StringuserName
Stringpassword
StringuseSSL
boolean$class: 'MonkeyBuilder'filename
StringpackageId
StringeventCount
intthrottleMs
intseed
Stringcategories
StringextraParameters
StringmoveComponentsnexusInstanceId
Stringdestination
Stringsearch (optional)
java.lang.String>
tagName (optional)
StringmsbuildmsBuildName
StringmsBuildFile
Give the .proj or .sln file from the module root (SCM root directory or workspace directory) that MSBuild will use to build.
You can use build variables through the syntax ${var}.
StringcmdLineArgs
This is a whitespace separated-list of command-line arguments you can specify. These can be the same as if you were to run MSBuild from the command line.
StringbuildVariablesAsProperties
If set to true, Jenkins build variables will be passed to MSBuild as /p:name=value pairs.
Beware : Sensitive build variables such as passwords will not be added.
booleancontinueOnBuildFailure
If set to true, Job will continue despite MSBuild build failure.
booleanunstableIfWarnings
If set to true and warnings on compilation, the build will be unstable.
booleandoNotUseChcpCommand
boolean$class: 'MsBuildSQRunnerBegin'additionalArguments (optional)
StringmsBuildScannerInstallationName (optional)
StringprojectKey (optional)
StringprojectName (optional)
StringprojectVersion (optional)
StringsonarInstallationName (optional)
String$class: 'MsBuildSQRunnerEnd'$class: 'MsTestBuilder'msTestName
StringtestFiles
Specify the path to your MSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line.
You can use either relative path to the workspace or full path. Spaces in the path are allowed.
You can use Ant-style filters. i.e - foo/*, foo/**/bar.dll, foo/*.dll
Command Line Argument: /testcontainer
Stringcategories
Optional field, if you do not enter all test will run. If entered specify the test categories to run. You can use logical operators like:
| Cateogry Filter | Result |
| Priority1 | Any test with category Priority1 |
| Priority1&SpeedTest | Test that have both Priority1 and SpeedTest categories |
| Priority1|SpeedTest | Tests that have either Priority1 or SpeedTest categories |
| Priority1&!SpeedTest | Test that have Priority1 category and also do not have SpeedTest category. |
Command Line Argument: /category
StringresultFile
Specify name of the result file to create. The result file will be delete before each run and will be created relative to the workspace directory.
Command Line Argument: /resultsfile
StringcmdLineArgs
StringcontinueOnFail
Specify if the build should fail if a test fail (unchecked) or continue even if a test failed (checked).
boolean$class: 'MultiJobBuilder'phaseName
StringphaseJobs
jobName
StringjobAlias
StringjobProperties
StringcurrParams
booleanconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggerred job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleankillPhaseOnJobResultCondition
FAILURE, NEVER, UNSTABLEdisableJob
booleanenableRetryStrategy
booleanparsingRulesPath
StringmaxRetries
intenableCondition
booleanabortAllJob
booleancondition
StringbuildOnlyIfSCMChanges
booleanapplyConditionOnlyIfNoSCMChanges
booleanaggregatedTestResults
booleancontinuationCondition
ALWAYS, SUCCESSFUL, COMPLETED, UNSTABLE, FAILUREexecutionType
PARALLEL, SEQUENTIALLY$class: 'MystBuilder'mystAction
Stringconfig
StringmystWorkspace
Stringproperties
StringmystInstallationName
String$class: 'NISConnection'viewUrl
Stringaddress
Stringport
intprozent
intapiKeyapiUrl (optional)
Stringgroup (optional)
StringbinaryName (optional)
Stringdescription (optional)
StringwaitForResults (optional)
booleanwaitMinutes (optional)
intbreakBuildOnScore (optional)
booleanscoreThreshold (optional)
intapiKey (optional)
StringuseBuildEndpoint (optional)
booleandebug (optional)
booleanpassword (optional)
StringproxyEnabled (optional)
booleanshowStatusMessages (optional)
booleanstopTestsForStatusMessage (optional)
Stringusername (optional)
String$class: 'NSiqBuilder'srcDir
StringfileFilter
String$class: 'NantBuilder'nantBuildFile
StringnantName
Stringtargets
Stringproperties
String$class: 'NeoBuildAction'executable
/opt/NeoLoad 6.5/bin/NeoLoadCmd,
C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe or
/Applications/NeoLoad 6.5/bin/NeoLoadCmd.
StringprojectType
StringreportType
StringlocalProjectFile
/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp,
C:\neoload_projects\JenkinsExample\JenkinsExample.nlp or
/Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp or
C:\neoload_projects\JenkinsExample\JenkinsExample.yaml.
StringsharedProjectName
MyProjectName.
StringscenarioName
StringhtmlReport
${WORKSPACE}/neoload-report/report.html.
StringxmlReport
${WORKSPACE}/neoload-report/report.xml.
StringpdfReport
${WORKSPACE}/neoload-report/report.pdf.
StringjunitReport
${WORKSPACE}/neoload-report/junit-sla-results.xml.
StringscanAllBuilds
booleandisplayTheGUI
booleantestResultName
$Date{hh:mm - dd MMM yyyy} is replaced by the current date by NeoLoad and the value
${BUILD_NUMBER} is replaced by the current build number by Jenkins.
$Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER}).
StringtestDescription
StringlicenseType
StringlicenseVUCount
StringlicenseVUSAPCount
StringlicenseDuration
StringcustomCommandLineOptions
StringpublishTestResults
booleansharedProjectServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
Stringlabel
StringlicenseServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
Stringlabel
StringcollabPath
StringlicenseID
StringshowTrendAverageResponse
booleanshowTrendErrorRate
booleangraphOptionsInfo
name
Stringcurve
path
Stringstatistic
StringmaxTrends
int$class: 'NerrvanaPlugin'settingsXmlString
Stringloglevel
Stringneuvectorrepository
StringregistrySelection
StringnameOfVulnerabilityToFailFour (optional)
StringnameOfVulnerabilityToFailOne (optional)
StringnameOfVulnerabilityToFailThree (optional)
StringnameOfVulnerabilityToFailTwo (optional)
StringnumberOfHighSeverityToFail (optional)
StringnumberOfMediumSeverityToFail (optional)
StringscanLayers (optional)
booleantag (optional)
String$class: 'NexusArtifactUploader'nexusVersion
Stringprotocol
StringnexusUrl
StringgroupId
Stringversion
Stringrepository
StringcredentialsId
Stringartifacts
artifactId
Stringtype
Stringclassifier
Stringfile
String$class: 'NexusPublisherBuildStep'nexusInstanceId
StringnexusRepositoryId
Stringpackages
$class: 'MavenPackage'mavenCoordinate
groupId
StringartifactId
Stringversion
Stringpackaging
StringmavenAssetList
filePath
Stringclassifier
Stringextension
StringtagName (optional)
Stringnirmatabuilder
Delete App in Environment
Deletes the specified application from the specified environment.
Deploy App in Environment
Deploys the specified application from catalog to specified application.
Update App in Catalog
Updates the specified application in specified catalog.
Update App in Environment
Updates the specified application in specified environment.
deleteAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdeployAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intcatalog
Stringdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringdeployType
StringupdateAppInCatalogendpoint
Stringapikey
Stringcatalog
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringupdateAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
Stringnodejscicommand
StringnodeJSInstallationName
StringcacheLocationStrategy (optional)
defaultexecutorworkspaceconfigId (optional)
String$class: 'NopmdCheckPublisher'filesetList
pattern
StringexcludePattern
String$class: 'NouvolaBuilder'planID
StringapiKey
StringcredsPass
StringwaitTime
StringreturnURL
StringlistenTimeOut
String$class: 'NvEmulationBuilder'serverName
StringincludeClientIPs
StringexcludeServerIPs
StringreportFiles
StringthresholdsFile
StringuseProxyCheckbox
envVariable
Stringsteps
$class: 'OOBuildStep'ooServer
Stringbasepath
Default path: /Library
E.g.:
Library/Tutorials/subflows/
Library/Templates
StringselectedFlow
Stringargs
name
Stringvalue
StringretVariableToCheck
StringcomparisonOrdinal
intvalueToCompareWith
StringdesiredResultType
StringstepExecutionTimeout
xxx ms. The plugin will wait for this amount of time, then it will finish the Jenkins job and it will automatically put the build in the fail/unstable state.
StringrunName
String$class: 'OctoperfBuilder'credentialsId
StringscenarioId
StringstopConditions (optional)
org.jenkinsci.plugins.octoperf.conditions.TestStopCondition
OneSkyprojectId (optional)
StringresourcesPath (optional)
String$class: 'OpenShiftBuildVerifier'apiURL
StringbldCfg
Stringnamespace
StringauthToken
Stringverbose
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftBuilder'apiURL
StringbldCfg
Stringnamespace
Stringenv
name
Stringvalue
StringauthToken
Stringverbose
StringcommitID
StringbuildName
StringshowBuildLogs
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftCreator'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterJsonYaml'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterLabels'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
Stringvalues
String$class: 'OpenShiftDeleterList'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
String$class: 'OpenShiftDeployer'apiURL
StringdepCfg
Stringnamespace
StringauthToken
Stringverbose
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftDeploymentVerifier'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftExec'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringpod
Stringcontainer
Stringcommand
Stringarguments
value
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftImageTagger'apiURL
StringtestTag
StringprodTag
Stringnamespace
StringauthToken
Stringverbose
StringtestStream
StringprodStream
StringdestinationNamespace
StringdestinationAuthToken
Stringalias
String$class: 'OpenShiftScaler'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftServiceVerifier'apiURL
StringsvcName
Stringnamespace
StringauthToken
Stringverbose
String$class: 'OrchestratorBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringworkflowName
StringwaitExec
booleaninputParams
name
Stringtype
Stringvalue
StringuTesterPageCountTaskinitialUrl
StringurlsWhiteList
StringpageCount
intrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
int$class: 'ParallelTestExecutor'This builder can be used with any test job that (1) produce JUnit-compatible XML files, and (2) accept a test-exclusion list in a file. This builder looks at the test execution time from the last time, and divide tests into multiple units of roughly equal size. Each unit is then converted into the exclusion list (by excluding all but the tests that assigned to that unit), and the test job is triggered for each unit, with the exclusion file placed inside the workspace at your specified location.
Optionally, if your test job supports it, you may provide a test-inclusion file name. If defined, the plugin will generate inclusion lists for all parallel units but one which will still use exclusion list. This avoids new test cases from being included in all units on their first run. If you don't use an inclusion file, when a new test is added, the first build afterward will be executed in all the sub-builds, because it's not in the exclusion list on any of the units.
You are responsible for configuring the build script in the test job to honor the exclusion and inclusion file. A standard technique is to write the build script to always refer to a fixed exclusion list file, and check in an empty file by that name to your SCM. You can then specify that file as the "exclusion file name" in the configuration of this builder, and the builder will overwrite the empty file from SCM by the generated one.
Similarly, you are responsible for checking "Execute concurrent builds if necessary" on the test job to allow the concurrent execution.
At the end of the executions of the test job, the specified report directories are brought back into this job's workspace, then the standard JUnit test report collector will tally them.
parallelism
countsize
inttimeThis value counts just the time spent on executing tests, and not including other time such as checking out the code, building the test, etc. For example, if your test job spends 50 minutes in tests and 60 minutes total from start to finish, then you have 10 minutes "fixed" overhead regardless of the number of tests it executes. If you use this mode and set the value to "10 minutes", then you'll have 5 parallel sub-tasks that all ends in roughly 20 minutes (20 mins = 10 mins tests time + 10 mins overhead.)
"N minutes per a sub-task" is a goal, not a hard constraint. So a sub-task can take longer (for example if you have a single test that takes more than N minutes.)
mins
inttestJob
StringpatternFile
StringtestReportFiles
The path is relative to the workspace of the test job. For Maven builds, this value is normally "**/target/surefire-reports/".
StringarchiveTestResults
booleanparameters
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggerred job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleanestimateTestsFromFiles
booleanincludesPatternFile (optional)
String$class: 'ParameterPoolBuilder'projects
Stringname
Stringvalues
StringpreferError
boolean$class: 'PartialReleaseMgrSuccessfulBuilder'pcBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestId
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringpcGitBuilddescription
StringpcServerName
StringhttpsProtocol
booleancredentialsId
StringalmDomain
StringalmProject
StringserverAndPort
StringproxyOutURL
StringcredentialsProxyId
StringsubjectTestPlan
StringuploadScriptMode
RUNTIME_FILES, ALL_FILESremoveScriptFromPC
YES, NOimportTests
Note:
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the Performance Center project). If not specified, a Controller will be chosen from the different controllers available in the Performance Center project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the Performance Center project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the Performance Center root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
Duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
YES, NOpcRunBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestToRun
StringtestId
StringtestContentToCreate
The content of the field must either be:
Note:
| Parameter | Description | Required |
|---|---|---|
| test_name | The test name. | Yes |
| test_folder_path | The location of the test in the Test Management folder tree of the Performance Center project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the Performance Center root folder (named "Subject") | Yes |
| test_content | The content of the test that requires additional parameters specified in the 'test_content' table below. | Yes |
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the Performance Center project). If not specified, a Controller will be chosen from the different controllers available in the Performance Center project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the Performance Center project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the Performance Center root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringactivateDTConfigurationdynatraceProfile
Stringconfiguration
StringcreateMemoryDumpdynatraceProfile
Stringagent
Stringhost
StringautoPostProcess (optional)
booleancapturePrimitives (optional)
booleancaptureStrings (optional)
booleandogc (optional)
booleanlockSession (optional)
booleantype (optional)
StringstartSessiondynatraceProfile
StringtestCase
StringlockSession (optional)
booleanrecordingOption (optional)
StringstopSessiondynatraceProfile
StringcreateThreadDumpdynatraceProfile
Stringagent
Stringhost
StringlockSession (optional)
booleanblazeMeterTestcredentialsId (optional)
StringworkspaceId (optional)
StringtestId (optional)
StringabortJob (optional)
booleanadditionalTestFiles (optional)
StringgetJtl (optional)
booleangetJunit (optional)
booleanjobApiKey (optional)
StringjtlPath (optional)
StringjunitPath (optional)
StringmainTestFile (optional)
Stringnotes (optional)
StringreportLinkName (optional)
StringserverUrl (optional)
StringsessionProperties (optional)
Stringbztparams
StringalwaysUseVirtualenv (optional)
booleanbztVersion (optional)
StringgeneratePerformanceTrend (optional)
booleanprintDebugOutput (optional)
booleanuseBztExitCode (optional)
booleanuseSystemSitePackages (optional)
booleanworkingDirectory (optional)
Stringworkspace (optional)
String$class: 'PhingBuilder'name
StringbuildFile
If your build requires a custom -buildfile, specify it here. By default Phing will use the build.xml in the module directory, this option can be used to use build files with a different name or in somewhere outside the top directory.
And you can use environment variables such like ''$WORKSPACE''.
Stringtargets
Stringproperties
# comment name1=value1 name2=value2These are passed to Phing like "-Dname1=value1 -Dname2=value2"
StringuseModuleRoot
booleanoptions
String$class: 'PipelineGenerationStep'project
Name of the project. It is used as an identifier in the corresponding pipelines, folders and jobs being generated.
StringprojectScmType
Type of the SCM. Currently only svn and git are supported.
StringprojectScmUrl
URL to the project SCM. Without any branch indication.
For example:
svn, URL to the root of the project, without trunk or branches. git, URL of the remote.StringprojectScmCredentials
ID or UUID of the Jenkins credentials to use when connecting to the project SCM.
Stringbranch
SCM branch.
StringseedProject
Project name useable for folders, job names, etc.
StringseedBranch
Branch name useable for folders, job names, etc.
StringdisableDslScript
If checked, the pipeline generation disallows the direct execution of a DSL Groovy script. Only DSL libraries, configured through a seed.properties file are allowed. By default, both modes are allowed.
booleanscriptDirectory
Path to the directory which contains the pipeline script. Defaults to seed if not filled.
String$class: 'PlayBuilder'playToolHome
StringprojectPath
StringplayVersion
$class: 'Play1x'commands
$class: 'PlayAutoTest'$class: 'PlayBuild'$class: 'PlayClean'$class: 'PlayCompile'$class: 'PlayCustom'parameter
String$class: 'PlayDist'$class: 'PlayInstall'$class: 'PlayJavadoc'$class: 'PlayPackage'$class: 'PlayPrecompile'$class: 'PlayPublish'$class: 'PlayTest'$class: 'PlayTestOnly'parameter
String$class: 'PlayWar'parameter
String$class: 'Play2x'commands
$class: 'PlayAutoTest'$class: 'PlayBuild'$class: 'PlayClean'$class: 'PlayCompile'$class: 'PlayCustom'parameter
String$class: 'PlayDist'$class: 'PlayInstall'$class: 'PlayJavadoc'$class: 'PlayPackage'$class: 'PlayPrecompile'$class: 'PlayPublish'$class: 'PlayTest'$class: 'PlayTestOnly'parameter
String$class: 'PlayWar'parameter
Stringplotgroup
Stringstyle
StringcsvFileName
StringcsvSeries (optional)
file
Stringurl
StringinclusionFlag
StringexclusionValues
StringdisplayTableFlag
booleanexclZero (optional)
booleankeepRecords (optional)
booleanlogarithmic (optional)
booleannumBuilds (optional)
StringpropertiesSeries (optional)
file
Stringlabel
Stringtitle (optional)
StringuseDescr (optional)
booleanxmlSeries (optional)
file
Stringxpath
StringnodeType
Stringurl
Stringyaxis (optional)
StringyaxisMaximum (optional)
StringyaxisMinimum (optional)
String$class: 'PowerShell'command
String$class: 'PowerShellBuildStep'buildStepId
StringscriptBuildStepArgs
defineArgs
booleanbuildStepArgs
arg
String$class: 'PrereqBuilder'projects
StringwarningOnly
booleanprobelyScantargetId
StringcredentialsId
String$class: 'ProjectGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
String$class: 'ProjectPrerequisitesInstaller'protecodesccredentialsId (optional)
StringprotecodeScGroup (optional)
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/ or with Groups API https://protecode-sc.mydomain.com/api/groups/.
StringconvertToSummary (optional)
protecodesc.xml.
booleancustomHeader (optional)
StringdirectoryToScan (optional)
StringdontZipFiles (optional)
booleanendAfterSendingFiles (optional)
booleanfailIfVulns (optional)
booleanincludeSubdirectories (optional)
booleanpattern (optional)
StringprotecodeScanName (optional)
StringscanOnlyArtifacts (optional)
booleanscanTimeout (optional)
int$class: 'ProxyBuilder'projectName
String$class: 'PublishBuilder'packageid
StringnugetFeedUrl
StringnugetFeedApiKey
StringpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'PublishStepBuilder'packageId
StringnugetFeedUrl
StringnugetFeedUrlApi
StringpackageVersion
String$class: 'PullRequestCommenter'comment
String$class: 'PushBuilder'remoteImageStrategy
DO_NOT_USE, GENERATE_GIT, FIXEDhubUrls
Stringorganization
StringoverwriteOrganization
booleanremoteImageName
StringdateFormat
| y|Y | Year |
| M | Month |
| w | Week in year |
| W | Week in month |
| D | Day in year |
| d | Day in month |
| F | Day of week in month |
| E | Day name in week |
| u | Day number of week (1 = Monday, ..., 7 = Sunday) |
| H | Hour in day (0-23) |
| k | Hour in day (1-24) |
| K | Hour in am/pm (0-11) |
| h | Hour in am/pm (1-12) |
StringappendDate
booleanincrementVersion
boolean$class: 'Python'Runs a Python script (defaults to python interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'PythonBuilder'pythonName
Stringnature
Stringcommand
StringignoreExitCode
booleanqualityCloudsScancredentialsId
StringinstanceUrl
StringissuesCountThreshold
inttechDebtThreshold
intqcThreshold
inthighSeverityThreshold
int$class: 'QFTestConfigBuilder'In this build step you can select which test-suites your job should run.
Note that the path for a test-suite or parent folder has to be relative to the workspace, which has to be specified above under "Advanced Project Options - Use custom workspace".
Examples:
-"Suites/MySuite/some_suite.qft" only runs one test-suite
-"Suites/MySuite" runs all test-suites in the MySuite folder
-"*" runs all test-suites in your workspace
Any of these command line arguments under the label "Test execution" can be used for the execution of your test-suites.
For the post-build actions to work, make sure to provide the correct paths to the logs and reports:
Archive the artifacts: qftestJenkinsReports/$JOB_NAME/$BUILD_NUMBER/logs/*.q*
Publish HTML reports: qftestJenkinsReports/$JOB_NAME/$BUILD_NUMBER/html/ and change index.html to report.html
Publish JUnit test result report: qftestJenkinsReports/$JOB_NAME/$BUILD_NUMBER/junit/report_junit.xml
For further information please see the QF-Test manual.
suitefield
net.sf.json.JSONObject
customPath
By activating this option you can specify a dedicated QF-Test version, different from the installed one.
For example "C:\Program Files (x86)\qfs\qftest\qftest-<VERSION>\"
net.sf.json.JSONObject
customReports
This plugin will create a folder for temporary files in your workspace.
The default directory is /YourWorkspace/qftestJenkinsReports/, but it can be changed here.
In case the name is changed, the paths of the post-build actions also have to be adapted accordingly.
net.sf.json.JSONObject
daemon
Details on how to use the daemon mode can be found in the QF-Test manual.
Note: The daemon has to be started seperately. The plugin will not start or terminate the daemon.
net.sf.json.JSONObject
$class: 'QualityCenter'qcClientInstallationName
StringqcQTPAddinInstallationName
StringqcServerURL
qcbin folder of the Quality Center Web application.
StringqcLogin
StringqcPass
StringqcDomain
StringqcProject
StringqcTSFolder
StringqcTSName
StringqcTSLogFile
Name of the report that will be generated.
If several test sets are run in one build step, one report will be generated per test set. As such, you must ensure that the name will be unique by including the test set name in it (through the ${TS_NAME} variable). If it's not the case, then the name will be automatically post fixed with an underscore followed by the test set name.
You can use all standard environment variables plus:
${QC_DOMAIN} for the current Quality Center domain;${QC_PROJECT} for the current Quality Center project;${TS_FOLDER} for the current TestSet folder;${TS_NAME} for the TestSet name.StringqcTimeOut
intrunMode
StringrunHost
StringacrQuickTaskazureCredentialsId
StringresourceGroupName
StringregistryName
Stringarchitecture (optional)
StringbuildArgs (optional)
docker build --build-arg.
key
Stringvalue
Stringsecrecy
booleandockerfile (optional)
StringgitPath (optional)
StringgitRefspec (optional)
StringgitRepo (optional)
https://PAT@github.com/user/repo.git for private repo.
StringimageNames (optional)
image
Stringlocal (optional)
StringnoCache (optional)
no-cache flag when build as
docker build --no-cache
booleanos (optional)
StringsourceType (optional)
Stringtarball (optional)
http://remoteserver/myapp.tar.gz
Stringtimeout (optional)
intvariant (optional)
String$class: 'R'Runs an R script (defaults to RScript interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'RAD'activateProjectWorkspaceVar
WORKSPACE environment variable through the
PROJECT_WORKSPACE one.
WORKSPACE variable during this build step as it doesn't refer to the workspace of the project: It is internally used by RAD.
booleanbuildFile
build.xml one in the project's workspace. The base directory is the
workspace.
StringdeleteRadWorkspaceContent
.metadata folder.
booleandeleteRadWorkspaceMetadata
.metadata folder of RAD's workspace has to be removed before RAD is actually run.
booleanproperties
# comment
name1=value1
name2=value2
These are passed to RAD like "-Dname1=value1 -Dname2=value2"
StringradInstallationName
StringradWorkspace
Stringtargets
String$class: 'RPDCreateInstance'pack
StringinstanceName
StringcustomProfile
String$class: 'RPDDeployInstance'instanceName
Stringpack
Stringenvironment
Stringroute
StringcustomProfile
StringuseCustomProfile
boolean$class: 'RTCGitBuilder'serverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringannotateChangeLog
Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
booleanbuildDefinition (optional)
The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
StringjenkinsRootURI (optional)
StringjenkinsRootURIOverride (optional)
Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
booleantimeout (optional)
The timeout period in seconds for Jazz repository requests made during the build.
inttrackBuildWorkItem (optional)
Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
StringuseBuildDefinition (optional)
booleanuseTrackBuildWorkItem (optional)
booleanuseWorkItems (optional)
booleanworkItemUpdateType (optional)
StringrabbitMQPublisherrabbitName
Stringexchange
Stringdata
Stringconversion (optional)
booleanroutingKey (optional)
StringtoJson (optional)
boolean$class: 'RadarGunBuilder'radarGunInstance
$class: 'RadarGunCustomInstallation'home
String$class: 'RadarGunInstallationWrapper'radarGunName
StringscenarioSource
$class: 'FileScenarioSource'scenarioPath
String$class: 'TextScenarioSource'scenario
StringnodeSource
$class: 'FileNodeConfigSource'nodeListPath
String$class: 'TextNodeConfigSource'nodes
StringscriptSource
$class: 'BuildInScriptSource'$class: 'FileScriptSource'masterPath
StringslavePath
String$class: 'TextScriptSource'masterScript
StringslaveScript
StringremoteLoginProgram
StringremoteLogin
StringworkspacePath
StringpluginPath
StringpluginConfigPath
StringreporterPath
String$class: 'Rake'rakeInstallation
StringrakeFile
Stringtasks
StringrakeLibDir
StringrakeWorkingDir
Stringsilent
booleanbundleExec
boolean$class: 'RallyBuild'preRallyState
stateName
StringissueString
StringupdateOnce
booleanpreComment
preCommentText
StringpreReady
preReadyState
booleanchangeReady
issueReady
booleancreateComment
commentText
StringchangeRallyState
issueRallyState
StringchangeDefectRallyState
defectRallyState
StringrancherenvironmentId
Stringendpoint
StringcredentialId
Stringservice
Stringimage
Stringconfirm
booleanstartFirst
booleanports
Stringenvironments
Stringtimeout
int$class: 'RanorexRunnerBuilder'rxTestSuiteFilePath
StringrxRunConfiguration
StringrxReportDirectory
StringrxReportFile
StringrxReportExtension
StringrxJUnitReport
booleanrxZippedReport
booleanrxZippedReportDirectory
StringrxZippedReportFile
StringrxGlobalParameter
StringcmdLineArgs
| Flag | Function |
|---|---|
| config | cfg:<config parameter name>=<value> | Set values for configuration parameters. |
| reportlevel | rl: Debug|Info|Warn|Error|Success|Failure|<any integer> | Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120 |
| testcase | tc:<name or guid of test case> | Runs this test case only. |
| testsuite | ts:<path to test suite file> | Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>. |
| module | mo:<module name or guid> | Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched. |
| testcaseparam | tcpa:<name or guid of test case>:<parameter name>=<value> | Creates or overrides values for testcase parameters specified in the test suite. |
| runlabel | rul:<custom value> | Sets a custom runlabel for the test run. |
| testcasedatarange | tcdr:<name or guid of test case>=<data range> | Sets the data range for a testcase. |
String$class: 'RapidDeployJobPlanRunner'serverUrl
StringauthenticationToken
StringjobPlan
StringasynchronousJob
booleanshowFullLogs
boolean$class: 'RapidDeployJobRunner'serverUrl
StringauthenticationToken
Stringproject
Stringtarget
StringpackageName
StringasynchronousJob
boolean$class: 'RapidDeployPackageBuilder'serverUrl
StringauthenticationToken
Stringproject
StringenableCustomPackageName
booleanpackageName
StringarchiveExtension
String$class: 'RebaseBuilder'You can rebase from the latest revision in the upstream branch, but you can also do safer rebase by choosing the permalink. For example, if you specify "last stable", then Jenkins will look for the last stable build, then rebase with the corresponding Subversion revision. Thus you know that you are rebasing to the known good state.
If you don't want Jenkins to automatically rebase, you can still use the "Rebase From Upstream" link from the left to manually initiate the rebase.
permalink
StringstopBuildIfMergeFails
booleansetUnstableIfMergeFails
boolean$class: 'RebootIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'ReconfigureBox'id
Stringcloud
Stringworkspace
Stringbox
Stringinstance
Stringvariables
StringbuildStep
StringbuildStepVariables
String$class: 'ReinstallBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringandroidApkMoveapkFilesPattern (optional)
StringapplicationId (optional)
StringfromVersionCode (optional)
booleangoogleCredentialsId (optional)
StringrolloutPercentage (optional)
StringtrackName (optional)
StringversionCodes (optional)
String$class: 'RemoteBuildConfiguration'abortTriggeredJob (optional)
booleanauth2 (optional)
CredentialsAuthcredentials (optional)
StringNoneAuthNullAuthTokenAuthapiToken (optional)
StringuserName (optional)
StringblockBuildUntilComplete (optional)
booleandisabled (optional)
booleanenhancedLogging (optional)
booleanjob (optional)
StringloadParamsFromFile (optional)
booleanmaxConn (optional)
intparameterFile (optional)
Stringparameters (optional)
StringpollInterval (optional)
intpreventRemoteBuildQueue (optional)
booleanremoteJenkinsName (optional)
StringremoteJenkinsUrl (optional)
StringshouldNotFailBuild (optional)
booleantoken (optional)
StringuseCrumbCache (optional)
booleanuseJobInfoCache (optional)
booleancrxReplicatepackageIds (optional)
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
long$class: 'Restart'apiKey
StringappName
StringpublishReview$class: 'ReviewboardApplyPatch'$class: 'ReviewboardPollingBuilder'reviewbotJobName
StringcheckBackPeriod
StringreviewbotRepoId
StringrestrictByUser
booleandisableAdvanceNotice
boolean$class: 'RigorBuilder'credentialsId
Please select a credential of Kind Rigor API Key here.
Note: Your Rigor Optimization API key can be found on the API Credentials settings page in the Rigor Optimization application. The API key must have User or higher level permissions.
StringperformanceTestIds
List 1 or more test IDs (as a comma separated list) of Rigor Optimization Performance Tests to be run during this step. You can locate the performance test ID by hovering over the Info (i) icon on any performance test in the View Results page of your Rigor Optimization account.
If Fail build based on results is checked below, this step will wait until all tests complete before proceeding. If unchecked, this step will launch these tests, but not wait for them to complete.
StringfailOnSnapshotError
If checked, the build will be marked as failed if there are any errors running your configured performance tests. If unchecked, any errors creating tests will be treated as warnings and not fail the build.
booleanfailOnResults
If checked, the build will wait for your configured tests to complete (may take 30 seconds to a few minutes) and pass/fail based on the results configured below. If unchecked, your configured tests will run, but the build will not wait for the tests to complete nor fail this step based on any results (useful for historical change logging of your site in the Rigor Optimization application).
booleanperformanceScore
Optional
Fail the build if any test reports an overall performance score lower than this value (1-100)
StringcriticalNumber
Optional
Fail the build if any test has more than this # of critical first party content defects found.
Note: You can customize when critical defects occur by customizing your Defect Check Policy. Learn more in this article.
StringfoundDefectIds
Optional
Fail the build if any of the listed defect IDs (comma separated) are found for any first party content items in any configured test.
Note: You can locate any defect ID at the top of any defect detail page in your results, or in the Knowledge Base. See Example.
StringenforcePerformanceBudgets
Optional
Fail the build if any test exceeds its performance budgets
booleantotalContentSize
StringtotalFoundItems
StringtestTimeoutSeconds
Timeout in seconds to wait for all configured performance tests to complete. Defaults to 300 seconds (5 minutes).
This value is only used if Fail build based on test results is enabled.
String$class: 'Rollback'apiKey
StringappName
String$class: 'RollbackBuilder'basePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
StringnumberOfChangesetsToRollback (optional)
Stringpassword (optional)
StringrollbackLastHours (optional)
StringrollbackToDate (optional)
StringrollbackToTag (optional)
StringrollbackType (optional)
Stringurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
String$class: 'RqmBuilder'collectionStrategy
$class: 'RqmTestSuiteExectionRecordCollectionStrategy'executionRecordName
StringplanName
StringprojectName
StringiterativeTestCaseBuilders
$class: 'RubyMotionBuilder'platform
StringrakeTask
StringoutputStyle
StringoutputFileName
StringuseBundler
booleaninstallCocoaPods
booleanneedClean
booleanoutputResult
booleandeviceName
StringsimulatorVersion
StringenvVars
String$class: 'RunApplicationAction'applicationName
Application selection is mandatory
Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
StringactionName
Application Action selection is mandatory
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringrunFromAlmBuilderalmServerName
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringalmTestSets
StringalmRunResultsMode
StringalmTimeout
StringalmRunMode
StringalmRunHost
StringisFilterTestsEnabled (optional)
booleanfilterTestsModel (optional)
blockedCheckbox
booleanfailedCheckbox
booleannotCompletedCheckbox
booleannoRunCheckbox
booleanpassedCheckbox
booleantestName (optional)
String$class: 'RunFromFileBuilder'fsTests
StringfileSystemTestSetModel
fileSystemTestSet
tests
StringparallelRunnerEnvironments
environment
StringenvironmentType
StringsummaryDataLogModel
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringscriptRTSSetModel
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringisParallelRunnerEnabled (optional)
booleanuftSettingsModel (optional)
selectedNode (optional)
StringnumberOfReruns (optional)
StringcleanupTest (optional)
StringonCheckFailedTest (optional)
StringfsTestType (optional)
StringrerunSettingsModels (optional)
test (optional)
Stringchecked (optional)
booleannumberOfReruns (optional)
intcleanupTest (optional)
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsAutActions (optional)
StringfsDeviceId (optional)
StringfsDevicesMetrics (optional)
StringfsExtraApps (optional)
StringfsInstrumented (optional)
StringfsJobId (optional)
StringfsLaunchAppName (optional)
StringfsManufacturerAndModel (optional)
StringfsOs (optional)
StringfsPassword (optional)
StringfsReportPath (optional)
StringfsTargetLab (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringfsUserName (optional)
StringignoreErrorStrings (optional)
StringmcServerName (optional)
StringmcTenantId (optional)
StringperScenarioTimeOut (optional)
StringproxySettings (optional)
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
hudson.util.Secret
useSSL (optional)
boolean$class: 'RunFromSrfBuilder'srfTestId
StringsrfTagNames
StringsrfReleaseNumber
StringsrfBuildNumber
StringsrfTunnelName
StringsrfCloseTunnel
booleansrfTestParameters
name
Stringvalue
StringshouldGetOnlyFirstValueFromJson
boolean$class: 'RunInCloudBuilder'projectId
The Bitbar Cloud project in which to start the new test run.
StringappPath
StringtestPath
StringdataPath
StringtestRunName
Stringscheduler
StringtestRunner
StringdeviceGroupId
Stringlanguage
StringscreenshotsDirectory
StringkeyValuePairs
StringwithAnnotation
StringwithoutAnnotation
StringtestCasesSelect
StringtestCasesValue
StringfailBuildIfThisStepFailed
booleanwaitForResultsBlock
testRunStateCheckMethod (optional)
HOOK_URL, API_CALLdownloadScreenshots (optional)
booleanforceFinishAfterBreak (optional)
booleanhookURL (optional)
StringresultsPath (optional)
StringwaitForResultsTimeout (optional)
inttestTimeout
StringcredentialsId
StringcloudUrl
StringcloudUIUrl
StringframeworkId
longosType
IOS, ANDROID, DESKTOP, UNDEFINEDruntpjobprojectId (optional)
StringjobId (optional)
StringwaitJobFinishSeconds (optional)
int$class: 'RunLoadRunnerScript'scriptsPath
String$class: 'RunPcTestBuildStep'almPassword (optional)
StringalmUser (optional)
Stringdomain (optional)
StringfailIfTaskFails (optional)
booleanoutputDir (optional)
StringpollingInterval (optional)
intpostRunActionString (optional)
Stringproject (optional)
StringretryCollateAndAnalysisAttempts (optional)
intretryCollateAndAnalysisFlag (optional)
booleanretryCollateAndAnalysisInterval (optional)
intretryCount (optional)
intretryInterval (optional)
intretryIntervalMultiplier (optional)
doubletestLabPath (optional)
StringtestPlanPath (optional)
Stringtimeout (optional)
inttimeslotDuration (optional)
intvudsMode (optional)
boolean$class: 'RunProcess'apiKey
StringappName
Stringcommand
String$class: 'RunTestSetBuildStep'domain
Stringproject
StringrunMode
Stringhost
StringtestSets
StringoutputDirPath
StringtimeOut
int$class: 'RunUftTestBuildStep'testPath
StringoutputDirPath
String$class: 'RunscopeBuilder'triggerEndPoint
StringaccessToken
Stringtimeout
ints3CopyArtifactprojectName
StringbuildSelector
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacefilter
StringexcludeFilter
Stringtarget
Stringflatten
booleanoptional
boolean$class: 'SASUnitPlugInBuilder'This is the Jenkins Plug-In for SASUnit the unit testing framework for SAS.
sasunitBatch
StringdoxygenBatch
Please enter the relative path to the executable to create the doxygen report
StringsasunitVersion
Please pick a SASUnit installation that shall be used.
To add an installation please go to Jenins->Manage Jenkins->Setting or follow this link.
StringcreateDoxygenDocu
boolean$class: 'SBuild'sbuildVersion
Stringtargets
StringbuildFiles
Stringoptions
StringscmSkipdeleteBuild (optional)
booleanskipPattern (optional)
StringsilkcentralprojectId
intexecDefIds
StringbuildNumberUsageOption (optional)
intcollectResults (optional)
booleancontOnErr (optional)
booleandelay (optional)
intignoreSetupCleanup (optional)
booleanjobName (optional)
StringspecificPassword (optional)
StringspecificServiceURL (optional)
StringspecificUser (optional)
StringuseSpecificInstance (optional)
boolean$class: 'SConsBuilderCommand'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
StringcommandScript
String$class: 'SConsBuilderScriptFile'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
Stringsconsscript
String$class: 'SMABuilder'validateEnabled
booleanusername
Stringpassword
StringsecurityToken
StringserverType
StringtestLevel
StringprTargetBranch
String$class: 'SQLPlusRunnerBuilder'credentialsId
Stringinstance
StringscriptType
Stringscript
StringscriptContent
| SELECT sysdate from dual; show user; |
StringcustomOracleHome (optional)
StringcustomSQLPlusHome (optional)
StringcustomTNSAdmin (optional)
String$class: 'SSHBuilder'siteName
Stringcommand
StringexecEachLine
Execute each line in the script individually.
By default, all of the commands are concatenated into a single "command" issued over a single SSH exec channel. Selecting this option causes each line to be executed over it's own SSH exec channel, each of which is part of the same session.
This is useful in certain cases where the commands cannot be concatenated into a single script executed at one time, for example, when issuing commands using the sourceforge.net shell.
If unsure, leave this box unchecked.
booleanhideCommand (optional)
boolean$class: 'SaltAPIBuilder'authtype
StringclientInterface
hookpost
Stringtag
Stringbatchfunction
Stringarguments
StringbatchSize
StringbatchWait
Stringtarget
Stringtargettype
Stringlocalfunction
Stringarguments
Stringtarget
Stringtargettype
Stringblockbuild (optional)
booleanjobPollTime (optional)
intminionTimeout (optional)
intsubsetfunction
Stringarguments
Stringsubset
Stringtarget
Stringtargettype
Stringrunnerfunction
Stringarguments
Stringmods
Stringpillarvalue
StringcredentialsId
Stringservername (optional)
StringsaveEnvVar (optional)
booleansaveFile (optional)
booleanskipValidation (optional)
boolean$class: 'SbtPluginBuilder'name
StringjvmFlags
StringsbtFlags
Stringactions
StringsubdirPath
String$class: 'ScaleProcess'apiKey
StringappName
StringprocessType
Stringquantity
int$class: 'ScriptBuildStep'buildStepId
StringscriptBuildStepArgs
defineArgs
booleanbuildStepArgs
arg
Stringtokenized
boolean$class: 'ScriptExecutionBuilder'autoScript
Type the Perfecto repository path name.
For example, to find a script called AndroidScript located in the my scripts folder, in the PRIVATE subarea, type or select PRIVATE:my scripts/AndroidScript.
After selecting or entering the script name you should click Refresh parameters to refresh the script parameters.
Note that values entered for some parameter will be preserved for same parameter name/type of the newly selected script.
StringscriptParams
Click the Refresh parameters list button to display the runtime parameters defined in the script.
Fill in the parameter values as specified below for each type.
String/integer: simply type them
For example, "appIdentifier(string)=Perfecto Mobile OSE"
Device parameter: The value should be the device id of the required device
Use the "Device and Media parameter value assistance" to find the id. For example: "DUT(Device)=TA8830NFLG"
Media/DataTable parameter: Enter the repository key and optionally the workspace location of the file to upload, separated by a semicolon.
For example, "PRIVATE:myfolder/TestApp.apk;mybuild\TestApp.apk"
Use the "Device and Media parameter value assistance" to find the repository path.
How to use the "Device and Media parameter value assistance":
NOTICE: It is not recommended to use runtime parameter of type Handset (Device) ; the specified device may be unavailable at runtime. Instead, use the Select device command within your script to select an available device at runtime. Click here for more information.
Device: Scroll and select the required device. Click on "Copy to clipboard" and then copy the id and paste into the parameter.
Media: Find the repository path by typing the path in the field. Select an item from the list, then use the clipboard to copy/paste the value into the parameter.
Stringid
StringautoMedia
Select the repository item path, copy it, then insert as a repository path of a parameter of type Media.
String$class: 'SecurityCheckerBuilder'$class: 'SeleniumAutoExecBuilder'serverUrl
String$class: 'SeleniumBuilderBuilder'scriptFile
StringparallelSettings
threadPoolSize
int$class: 'SelfServiceBookmarkBuilder'delphixEngine
StringdelphixBookmark
StringdelphixOperation
StringdelphixContainer
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SelfServiceContainerBuilder'delphixEngine
StringdelphixEnvironment
StringdelphixOperation
StringdelphixBookmark
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SemanticVersioningBuilder'parser
StringnamingStrategy
StringuseJenkinsBuildNumber
booleanenvVariable
String$class: 'SendMessageBuildStep'message
Stringfilepath
Stringrecipients
id
StringsensediaApiDeployenviromentName
Stringrevision
StringsensediaApiJsonapiId
StringsensediaApiQArevisionNumber
intdestination
booleanlogInterceptor
booleanresourceOutOfSize
booleanresourceSize
intshellBy default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
command
StringsignAndroidApksandroidHome (optional)
zipalign tool. You can also set the
ANDROID_HOME environment variable in your Jenkins system or node configuration. E.g.,
/usr/local/android-sdk.
StringapksToSign (optional)
myApp/build/outputs/apk/myApp-unsigned.apk or
**/*-unsigned.apk or
app1/**/*-unsigned.apk, app2/**/*-unsigned.apk.
StringarchiveSignedApks (optional)
SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk, where
myApp-unsigned.apk is a directory named for the input unsigned APK.
booleanarchiveUnsignedApks (optional)
booleankeyAlias (optional)
Key Store ID references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
StringkeyStoreId (optional)
StringsignedApkMapping (optional)
unsignedApkNameDirunsignedApkSiblingskipZipalign (optional)
booleanzipalignPath (optional)
zipalign executable this build step should
use to align the target APKs. You can also set the
ANDROID_ZIPALIGN environment variable in your Jenkins system or node configuration. E.g.,
/opt/android-tools/bin/zipalign
String$class: 'SilkPerformerBuilder'projectLoc
Stringworkload
StringsuccessCriteria
userType
StringmeasureCategory
StringmeasureType
StringmeasureName
StringvalueType
StringoperatorType
StringchosenValue
String$class: 'SingleConditionalBuilder'buildStep
$class: 'SkytapBuilder'action
$class: 'AddConfigurationToProjectStep'configurationID
StringconfigurationFile
StringprojectID
StringprojectName
String$class: 'AddTemplateToProjectStep'templateID
StringtemplateFile
StringprojectID
StringprojectName
String$class: 'ChangeConfigurationStateStep'configurationID
StringconfigurationFile
StringtargetRunState
StringhaltOnFailedShutdown
boolean$class: 'ChangeContainerStateStep'containerID
StringcontainerFile
StringtargetContainerAction
String$class: 'ChangeVMContainerHostStatus'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerHostStatus
String$class: 'ConnectToVPNTunnelStep'configurationID
StringconfigurationFile
StringconfigurationNetworkName
StringvpnID
String$class: 'CreateConfigurationStep'templateID
StringtemplateFile
StringconfigName
StringconfigFile
String$class: 'CreateContainerStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerRegistryName
StringrepositoryName
StringcontainerName
If no name is provided, the container will be named New_Container_[timestamp]
StringcontainerCommand
If no command is provided, will default to using the command in the image spec (if applicable).
StringexposeAllPorts
booleancontainerSaveFilename
String$class: 'CreatePublishURLStep'configurationID
StringconfigurationFile
StringurlSaveFilename
StringportalName
StringpermissionOption
Don't Publish: The Sharing Portal URL will not be available to the user in any way.
View Only: User can view the VM through the Sharing Portal URL. No mouse or keyboard control is allowed, and desktop resizing is disabled.
Use:User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed.
Run, Suspend: User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed, and the user can also run the machine if it is in a stopped or suspended state.
StringhasPassword
urlPassword
String$class: 'CreatePublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'CreateTemplateFromConfigurationStep'configurationID
StringconfigurationFile
StringtemplateName
StringtemplateDescription
StringtemplateSaveFilename
String$class: 'DeleteConfigurationStep'configurationID
StringconfigurationFile
String$class: 'DeleteContainerStep'containerID
StringcontainerFile
String$class: 'GetContainerMetaDataStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerName
StringcontainerDataFile
String$class: 'ListPublishedURLForConfigurationStep'configurationID
StringconfigurationFile
StringurlName
StringurlFile
String$class: 'ListVMPublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'MergeTemplateIntoConfigurationStep'configurationID
StringconfigurationFile
StringtemplateID
StringtemplateFile
StringconfigFile
String$class: 'NetworkConnectStep'sourceNetworkConfigurationID
StringtargetNetworkConfigurationID
StringsourceNetworkConfigurationFile
StringtargetNetworkConfigurationFile
StringsourceNetworkName
StringtargetNetworkName
String$class: 'SmartFrogBuilder'smartFrogName
StringdeployHost
Stringhosts
StringsfUserHome
StringsfUserHome2
StringsfUserHome3
StringsfUserHome4
StringsfOpts
StringbuilderId
StringuseAltIni
booleansfIni
StringsfScriptSource
$class: 'FileScriptSource'scriptName
StringscriptPath
String$class: 'StringScriptSource'scriptName
StringscriptContent
String$class: 'SnapshotBuilder'xStudioPath
StringxStudioLicensePath
StringvagrantBox
Stringoverwrite
booleanpreInstallScriptPath
StringpostSnapshotScriptPath
StringresourceDirectoryPath
Stringdependencies
StringsnapshotFilesToDelete
StringinstallScriptSettings
org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$InstallScriptSettings
startupFileSettings
org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$StartupFileSettings
snykSecurityadditionalArguments (optional)
Additional runtime arguments that will be used to invoke the Snyk CLI. See the Snyk CLI help page for more details.
Use the standalone double-dash -- to pass arguments to the build tool invoked by the Snyk CLI. For example:
-- -Pprofile -Dkey=value for Maven projects.-- --configuration runtime for Gradle projects.-- -Dkey=value for SBT projects.StringfailOnIssues (optional)
The "When issues are found" selection specifies if builds should be failed or continued based on issues found by Snyk.
The corresponding CLI option for severity parameter: --severity-threshold
booleanmonitorProjectOnBuild (optional)
Monitor the project on every build by taking a snapshot of its current dependencies on Snyk.io. Selecting this option will keep you notified about newly disclosed vulnerabilities and remediation options in the project.
booleanorganisation (optional)
The Snyk organisation in which this project should be tested and monitored. Leave empty to use your default organisation.
The corresponding CLI option for this parameter: --org
StringprojectName (optional)
A custom name for the Snyk project created for this Jenkins project on every build. Leave empty for the project's name to be detected in the manifest file.
The corresponding CLI option for this parameter: --project-name
Stringseverity (optional)
StringsnykInstallation (optional)
Ensures that the selected version of Snyk tools are installed. In addition, the Snyk tools will be added at the start of the PATH environment variable during builds.
If no Snyk installations have been defined in the Jenkins system config, then none of the above steps will take place.
StringsnykTokenId (optional)
The ID for the API token from the Credentials plugin to be used to authenticate to Snyk. The type of the credential must be "Snyk API token"
StringtargetFile (optional)
The path to the manifest file to be used by Snyk. Leave empty for Snyk to auto-detect the manifest file in the project's root folder.
The corresponding CLI option for this parameter: --file
StringaddALMOctaneSonarQubeListenerpushCoverage (optional)
booleanpushVulnerabilities (optional)
booleansonarServerUrl (optional)
StringsonarToken (optional)
String$class: 'SonarRunnerBuilder'additionalArguments (optional)
StringinstallationName (optional)
StringjavaOpts (optional)
Stringjdk (optional)
Stringproject (optional)
Stringproperties (optional)
StringsonarScannerName (optional)
Stringtask (optional)
String$class: 'SoundsBuildTask'afterDelayMs
StringsoundSource
selectedSound
Stringvalue
INTERNAL, URLsoundUrl
String$class: 'SparkNotifyBuilder'disable
booleanmessageType
StringroomList
rName
StringrId
StringmessageContent (optional)
StringcredentialsId (optional)
StringspringBootselectedIDs (optional)
StringartifactId (optional)
Stringautocomplete (optional)
StringbootVersion (optional)
Stringdescription (optional)
StringgroupId (optional)
StringjavaVersion (optional)
Stringlanguage (optional)
Stringpackaging (optional)
StringprojectName (optional)
Stringtype (optional)
String$class: 'SrfServerSettingsBuilder'credentialsId
StringsrfServerName
StringsrfProxyName
StringsrfTunnelPath
StringsseBuildalmServerName
StringalmProject
StringcredentialsId
StringclientType
StringalmDomain
StringrunType
StringalmEntityId
StringtimeslotDuration
StringcdaDetails (optional)
deploymentAction
StringdeployedEnvironmentName
StringdeprovisioningAction
Stringdescription (optional)
StringenvironmentConfigurationId (optional)
StringpostRunAction (optional)
StringosfBuilderSuiteStandaloneSonarLintersourcePatterns (optional)
sourcePattern
StringexcludePatterns
excludePattern
StringreportPath (optional)
String$class: 'StartBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstartETConfigure and start a preconfigured ECU-TEST installation.
Pipeline usage
startET(String toolName) : void
startET(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debug, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start(String toolName) : void
ETInstance.start(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debug, boolean keepInstance, boolean updateUserLibs) : void
startET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startET installation: instance.installation, workspaceDir: 'C:\\Data'
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.start()
toolName
StringdebugMode (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepInstance (optional)
booleansettingsDir (optional)
Stringtimeout (optional)
StringupdateUserLibs (optional)
booleanworkspaceDir (optional)
String$class: 'StartGrid'url
StringcloudTestServerID
Stringname
StringtimeOut
int$class: 'StartRSDB'url
StringcloudTestServerID
Stringname
StringtimeOut
intstartTSConfigure and start Tool-Server.
Pipeline usage
startTS(String toolName) : void
startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS(String toolName) : void
ETInstance.startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
startTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.startTS()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepInstance (optional)
booleantcpPort (optional)
Stringtimeout (optional)
StringtoolLibsIni (optional)
String$class: 'StartTestEnvironment'url
StringcloudTestServerID
Stringname
StringtimeOut
int$class: 'StopBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstopETShutdown ECU-TEST.
Pipelines usage:
stopET(String toolName) : void
stopET(String toolName, int timeout) : void
ETInstance.stop(String toolName) : void
ETInstance.stop(String toolName, int timeout) : void
stopET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopET installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stop()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
timeout (optional)
String$class: 'StopGrid'url
StringcloudTestServerID
Stringname
String$class: 'StopRSDB'url
StringcloudTestServerID
Stringname
StringstopTSShutdown Tool-Server.
Pipelines usage:
stopTS(String toolName) : void
stopTS(String toolName, int timeout) : void
ETInstance.stopTS(String toolName) : void
ETInstance.stopTS(String toolName, int timeout) : void
stopTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stopTS()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
timeout (optional)
String$class: 'StopTestEnvironment'url
StringcloudTestServerID
Stringname
String$class: 'StudioToolsBuilder'name
Stringoperation
StringprojectDir
StringoutputArchiveFile
StringextendedClassPath
StringoverwriteOutput
booleanTRAPropertyFIle
StringtopazSubmitFreeFormJclconnectionId
StringcredentialsId
StringmaxConditionCode
Stringjcl
StringtopazSubmitJclMembersconnectionId
StringcredentialsId
StringmaxConditionCode
StringjclMember
String$class: 'SvChangeModeBuilder'serverName
Stringforce
booleanmode
OFFLINE, SIMULATING, STAND_BY, LEARNINGdataModel
selectionType
BY_NAME, NONE, DEFAULTdataModel
StringperformanceModel
selectionType
BY_NAME, NONE, OFFLINE, DEFAULTperformanceModel
StringserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SvDeployBuilder'serverName
Stringforce
booleanservice
StringprojectPath
StringprojectPassword
StringfirstAgentFallback
boolean$class: 'SvExportBuilder'serverName
Stringforce
booleantargetDirectory
StringcleanTargetDirectory
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringswitchToStandByFirst
booleanarchive
boolean$class: 'SvUndeployBuilder'serverName
StringcontinueIfNotDeployed
booleanforce
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SyncBuilder'packageid
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
Stringoptions
Stringfilter
StringpackageVersion
StringisolationLevel
StringupdateScript
booleansqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'SyncStepBuilder'packageId
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
hudson.util.Secret
compareOptions (optional)
StringtransactionIsoLvl (optional)
String$class: 'SystemGroovy'Executes a system groovy script similarly to hudson_url/script. The script is always executed on master.
Predefined variables:
build
AbstractBuild.
launcher
Launcher.
listener
BuildListener.
out
PrintStream (
listener.logger).
source
$class: 'FileSystemScriptSource'scriptFile
String$class: 'StringSystemScriptSource'script
script
Stringsandbox
booleanclasspath
path
Stringbindings (optional)
Define variable bindings (in the properties file format). Specified variables can be addressed from the script.
String$class: 'TATestRunRegistrationBuildStep'This step registers new test run with given category and sets the 'dtTestrunID' build variable.
category
Stringplatform
Stringtanaguruname
Stringscenario
StringurlToAudit
StringurlTanaguruWebService
StringperformanceUnstableMark
intperformanceFailedMark
intproxy_uri
Stringproxy_username
Stringproxy_password
String$class: 'TarGzDeployment'apiKey
StringappName
StringtargzPath
StringprocfilePath
String$class: 'TattletaleBuilder'inputDirectory
StringoutputDirectory
Stringtestcompletetestsuite (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringcommandLineArguments (optional)
StringexecutorType (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleanlaunchConfig (optional)
project (optional)
Stringroutine (optional)
Stringtest (optional)
Stringunit (optional)
Stringvalue (optional)
StringlaunchType (optional)
Stringproject (optional)
StringpublishJUnitReports (optional)
booleanroutine (optional)
StringsessionScreenResolution (optional)
Stringtest (optional)
Stringtimeout (optional)
Stringunit (optional)
StringuseActiveSession (optional)
booleanuseTCService (optional)
booleanuseTimeout (optional)
booleanuserName (optional)
StringuserPassword (optional)
String$class: 'TeamPendingStatusBuildStep'$class: 'TelegramBotBuilder'message
String$class: 'TelerikAppBuilder'applicationId
StringaccessToken
hudson.util.Secret
configuration
StringbuildSettingsiOS
mobileProvisionIdentifieriOS
StringcodesigningIdentityiOS
StringbuildSettingsAndroid
codesigningIdentityAndroid
StringbuildSettingsWP
boolean$class: 'TerminateBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
Stringdelete
boolean$class: 'TestBuilder'packageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
StringrunTestSet
value
StringrunOnlyParams
StringgenerateTestData
sqlgenPath
Stringoptions
Stringfilter
StringpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringtestSource
value
scaproject, socartifactprojectPath
Stringpackageid
StringpackageVersion
String$class: 'TestCompositionRunner'url
StringcloudTestServerID
Stringcomposition
StringdeleteOldResults
maxDaysOfResults
intadditionalOptions
Stringthresholds
transactionname
Stringthresholdname
Stringthresholdvalue
Stringthresholdid
StringgeneratePlotCSV
booleantestFoldertestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTIONrecursiveScan (optional)
booleanscanMode (optional)
PACKAGES_ONLY, PROJECTS_ONLY, PACKAGES_AND_PROJECTStestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestLinkBuilder'testLinkName
StringtestProjectName
StringtestPlanName
StringplatformName
StringbuildName
StringcustomFields
StringtestPlanCustomFields
StringexecutionStatusNotRun
booleanexecutionStatusPassed
booleanexecutionStatusFailed
booleanexecutionStatusBlocked
booleansingleBuildSteps
$class: 'TestOdysseyBuilder'jobId
StringprojectId
StringminPassPercentage
StringtestPackagetestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
StringtestProjecttestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTIONtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestRunner'stack
Stringbranch
StringtestNames
Stringundeploy
booleanapiKey
String$class: 'TestStepBuilder'packageId
StringserverType
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
hudson.util.Secret
runTestMode
StringrunTests
StringcompareOptions (optional)
StringdgenFile (optional)
StringgenerateTestData (optional)
boolean$class: 'TestStudioAPITestBuilder'apiRunnerPath (optional)
Stringproject (optional)
Stringtest (optional)
StringstartFrom (optional)
StringstopAfter (optional)
Stringvariable (optional)
StringdontSaveContexts (optional)
booleantestAsUnit (optional)
boolean$class: 'TestStudioTestBuilder'artOfTestRunnerPath
StringtestPath
StringsettingsPath
StringdateFormat
| Letter | Date or Time Component | Presentation | Examples |
|---|---|---|---|
| G | Era designator | Text | AD |
| y | Year | Year | 1996; 96 |
| Y | Week year | Year | 2009; 09 |
| M/L | Month in year | Month | July; Jul; 07 |
| w | Week in year | Number | 27 |
| W | Week in month | Number | 2 |
| D | Day in year | Number | 189 |
| d | Day in month | Number | 10 |
| F | Day of week in month | Number | 2 |
| E | Day in week | Text | Tuesday; Tue |
| u | Day number of week | Number | 1 |
| a | Am/pm marker | Text | PM |
| H | Hour in day (0-23) | Number | 0 |
| k | Hour in day (1-24) | Number | 24 |
| K | Hour in am/pm (0-11) | Number | 0 |
| h | Hour in am/pm (1-12) | Number | 12 |
| m | Minute in hour | Number | 30 |
| s | Second in minute | Number | 55 |
| S | Millisecond | Number | 978 |
| z | Time zone | General time zone | Pacific Standard Time; PST; GMT-08:00 |
| Z | Time zone | RFC 822 time zone | -0800 |
| X | Time zone | ISO 8601 time zone | -08; -0800; -08:00 |
| Input string | Pattern |
|---|---|
| 2001.07.04 AD at 12:08:56 PDT | yyyy.MM.dd G 'at' HH:mm:ss z |
| Wed, Jul 4, '01 | EEE, MMM d, ''yy |
| 12:08 PM | h:mm a |
| 12 o'clock PM, Pacific Daylight Time | hh 'o''clock' a, zzzz |
| 0:08 PM, PDT | K:mm a, z |
| 02001.July.04 AD 12:08 PM | yyyyy.MMMM.dd GGG hh:mm aaa |
| Wed, 4 Jul 2001 12:08:56 -0700 | EEE, d MMM yyyy HH:mm:ss Z |
| 010704120856-0700 | yyMMddHHmmssZ |
| 2001-07-04T12:08:56.235-0700 | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| 2001-07-04T12:08:56.235-07:00 | yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| 2001-W27-3 | YYYY-'W'ww-u |
StringprojectRoot (optional)
StringtestAsUnit (optional)
booleanoutputPath (optional)
String$class: 'TestSwarmBuilder'testswarmServerUrl
StringjobName
StringuserName
StringauthToken
StringmaxRuns
StringchooseBrowsers
StringpollingIntervalInSecs
StringtimeOutPeriodInMins
StringminimumPassing
StringtestSuiteList
testName
StringtestUrl
StringtestCacheCracker
booleandisableTest
booleantestweaverprojectPath
StringexperimentName
StringjUnitReportDirectory
StringhtmlReportDirectory (optional)
StringinstrumentView (optional)
booleannamespacePattern (optional)
StringparameterValues (optional)
StringrunScenarioLimit (optional)
intrunTimeLimit (optional)
longsilverParameters (optional)
String$class: 'TesteinRunBuilder'targetType
StringtargetId
StringdownloadReport
booleandownloadLogs
boolean$class: 'TesteinUploadStepBuilder'enableJs
jsFilePath
StringjsonFilePath
StringenableJar
jarFilePath
Stringoverwrite
boolean$class: 'TestingBotBuilder'name
String$class: 'TestiniumPlugin'projectId (optional)
intplanId (optional)
intabortOnError (optional)
booleanabortOnFailed (optional)
booleanfailOnTimeout (optional)
booleanignoreInactive (optional)
booleantimeoutSeconds (optional)
int$class: 'TestopiaBuilder'testopiaInstallationName
StringtestRunId
intsingleBuildSteps
convertTestsToRunframework
Stringformat
Stringdelimiter
StringtotaltestUTconnectionId
StringcredentialsId
StringprojectFolder
StringtestSuite
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
Stringjcl
StringccClearStats (optional)
booleanccDB2 (optional)
booleanccPgmType (optional)
StringccRepo (optional)
StringccSystem (optional)
StringccTestId (optional)
StringdeleteTemp (optional)
booleanhlq (optional)
StringhostPort (optional)
StringuseStubs (optional)
booleantotaltestenvironmentId
StringfolderPath
StringserverUrl
StringcredentialsId
StringaccountInfo (optional)
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
StringccThreshhold (optional)
inthaltAtFailure (optional)
booleanrecursive (optional)
booleanreportFolder (optional)
StringsonarVersion (optional)
StringsourceFolder (optional)
StringstopIfTestFailsOrThresholdReached (optional)
booleanuploadToServer (optional)
boolean$class: 'ToxBuilder'toxIni
Stringrecreate
booleantoxenvPattern
String$class: 'TptPlugin'exe
StringexePaths
Stringarguments
StringisTptMaster
booleanslaveJob
StringslaveJobCount
StringslaveJobTries
StringtptBindingName
StringtptPort
StringexecutionConfiguration
tptFile
Stringconfiguration
StringtestdataDir
StringreportDir
StringenableTest
booleantimeout
longtestSet
StringtptStartUpWaitTime
StringenableJunit
booleanjUnitreport
StringjUnitLogLevel
NONE, ERROR, WARNING, INFO, ALL$class: 'TptPluginSlave'exePaths
StringtptBindingName
StringtptPort
StringtptStartUpWaitTime
StringtricentisCItricentisClientPath (optional)
Stringendpoint (optional)
StringconfigurationFilePath (optional)
String$class: 'TriggerBuilder'configs
projects
Stringblock
buildStepFailureThreshold
StringunstableThreshold
StringfailureThreshold
StringconfigFactories
$class: 'AllNodesBuildParameterFactory'$class: 'AllNodesForLabelBuildParameterFactory'name
StringnodeLabel
StringignoreOfflineNodes
boolean$class: 'BinaryFileParameterFactory'This implementation does not interpret the contents of those files, and instead it simply gets passed and placed into the workspace of the triggered project(s) under the name specified here.
This is useful, for example, when you have a portion of the job that can be split into concurrently executable subtasks. In such a situation, you can have an earlier step produce subtask work units by packaging necessary stuff into individual files, then use this mode to execute them all in parallel.
parameterName
StringfilePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'CounterBuildParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'CounterGeneratorParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'FileBuildParameterFactory'filePattern
Stringencoding
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'FileGeneratorParameterFactory'filePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'MultipleBinaryFileParameterFactory'parametersList
org.jenkinsci.plugins.parallel_test_executor.MultipleBinaryFileParameterFactory$ParameterBinding
noFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'NodeListBuildParameterFactory'name
StringnodeListString
Stringconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggerred job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
boolean$class: 'TwitterPublisher'tokenCredentialsID
StringconsumerCredentialsID
StringtweetText
StringUiPathPackversion
AutoVersionCustomVersiontext
StringprojectJsonPath
StringoutputPath
String$class: 'UnicornValidationBuilder'unicornUrl
StringsiteUrl
StringmaxErrorsForStable
StringmaxWarningsForStable
StringmaxErrorsForUnstable
StringmaxWarningsForUnstable
String$class: 'UninstallBuilder'packageId
StringfailOnUninstallFailure
boolean$class: 'UnitTestBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringobjects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringowner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringtxt
booleanxml
boolean$class: 'Unity3dBuilder'For projects that use Unity3d as the build system.
This causes Jenkins to invoke the Unity3d Editor with the given command line arguments.
A non-zero exit code from Unity3d makes Jenkins mark the build as a failure.
unity3dName
StringargLine
-quit -batchmode -executeMethod YourEditorScript.YourBuildMethod [-nographics] or
-quit -batchmode -buildWindowsPlayer path/to/your/build.exe or
-quit -batchmode -buildOSXPlayer path/to/your/build.app
If this value isn't set, the globalArgLine is used.
Note: we make little to no attempt to detect conflicting arguments or arguments not suitable to the platform neither at configuration nor at runtime.
If the specified command line contains no -projectpath argument, the plugin automatically adds one with the proper parameter (the workspace of the project on the target machine). This is to make sure unity builds the proper project. Otherwise unity would reuse the last opened project. You can override it, but this hasn't been thoroughly tested.
If your build agent have multiple executors (which you should probably do), it is highly recommended to make use of a -logFile argument to avoid letting Unityed write to the standard editor.log concurrently. A recommended practise is to use something like -logFile "$WORKSPACE/unity3d_editor.log".
See the official Editor command line arguments documentation.
StringunstableReturnCodes
Stringunshelveshelf
Stringresolve
Stringtidy
booleanignoreEmpty
boolean$class: 'UpdateBox'cloud
Stringworkspace
Stringbox
Stringvariables
StringazureVMSSUpdateazureCredentialsId
StringresourceGroup
Stringname
StringimageReference
id (optional)
Resource ID or VHD URI of the custom image.
Example Resource ID: /subscriptions/your-subscription-id/resourceGroups/your-resource-group/providers/Microsoft.Compute/images/your-image-name
Example VHD URI: http://your-storage-account.blob.core.windows.net/vhds/your-disk-image.vhd
Stringoffer (optional)
Stringpublisher (optional)
Stringsku (optional)
Stringversion (optional)
StringazureVMSSUpdateInstancesazureCredentialsId
StringresourceGroup
Stringname
StringinstanceIds
,'.
String$class: 'UpdateProjectBuilder'$class: 'UploadAppBuildStep'applicationLocation
StringkeystoreInfo
keystoreLocation
StringkeystorePassword
StringkeyAlias
StringkeyPassword
StringextraArguments
touchId
booleancamera
booleanuuid
String$class: 'UploadAppBuilder'mcServerName
StringmcUserName
StringmcPassword
StringmcTenantId
StringproxySettings
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
hudson.util.Secret
applicationPaths
mcAppPath
Stringupload-pgyeruKey
StringapiKey
StringscanDir
Stringwildcard
StringinstallType
Stringpassword
StringupdateDescription
StringqrcodePath
StringenvVarsPath
Stringupload-pgyer-v2apiKey
StringscanDir
Stringwildcard
StringbuildName
StringbuildInstallType
StringbuildPassword
StringbuildUpdateDescription
StringqrcodePath
StringenvVarsPath
String$class: 'UploadJUnitTestResult'properties
java.lang.String>
uploadProgetPackagefeedName
StringgroupName
A string of no more than fifty characters:
StringpackageName
A string of no more than fifty characters:
Stringversion
Stringartifacts
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
StringcaseSensitive (optional)
org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
booleandefaultExcludes (optional)
booleandependencies (optional)
Stringdescription (optional)
Stringexcludes (optional)
Stringicon (optional)
Stringmetadata (optional)
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
Stringtitle (optional)
A string of no more than fifty characters
String$class: 'UpmergeBuilder'commitUsername
StringuTesterUrlListTaskinitialUrl
StringurlsWhiteList
StringrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
intuseMangouseSlaveNodes
StringnodeLabel
StringprojectId
StringfolderName
StringtestName
StringtestStatus
StringassignedTo
String$class: 'VB6Builder'projectFile
StringcompileConstants (optional)
StringoutDir (optional)
StringvCommanderaction
$class: 'VCommanderRequestNewServiceAction'payload
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderRunWorkflowAction'targetType
StringtargetName
StringworkflowName
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderWaitForRequestNewServiceAction'requestId
Stringtimeout
longpolling
long$class: 'VCommanderWaitForRunWorkflowAction'taskId
Stringtimeout
longpolling
long$class: 'VMGRAPI'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvAPIInput
StringvJsonInputFile
StringdeleteInputFile
booleanauthRequired
booleanapiType
StringdynamicUserId
booleanapiUrl
StringrequestMethod
StringadvConfig
booleanconnTimeout
intreadTimeout
int$class: 'VMGRLaunch'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvSIFName
StringvSIFInputFile
StringcredentialInputFile
StringdeleteInputFile
booleandeleteCredentialInputFile
booleanuseUserOnFarm
booleanauthRequired
booleanvsifType
StringuserFarmType
StringdynamicUserId
booleanadvConfig
booleanconnTimeout
intreadTimeout
intenvVarible
booleanenvVaribleFile
StringinaccessibleResolver
StringstoppedResolver
StringfailedResolver
StringdoneResolver
StringsuspendedResolver
StringwaitTillSessionEnds
booleanstepSessionTimeout
intgenerateJUnitXML
booleanextraAttributesForFailures
booleanstaticAttributeList
StringmarkBuildAsFailedIfAllRunFailed
booleanfailJobIfAllRunFailed
booleanenvSourceInputFile
StringvMGRBuildArchive
booleandeleteAlsoSessionDirectory
booleangenericCredentialForSessionDelete
booleanarchiveUser
StringarchivePassword
StringfamMode
StringfamModeLocation
StringnoAppendSeed
booleanmarkBuildAsPassedIfAllRunPassed
booleanfailJobUnlessAllRunPassed
booleanuserPrivateSSHKey
boolean$class: 'VSphereBuildStepContainer'buildStep
$class: 'Clone'sourceName
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringpowerOn
booleantimeoutInSeconds
intcustomizationSpec
String$class: 'ConvertToTemplate'vm
Stringforce
boolean$class: 'ConvertToVm'template
StringresourcePool
Stringcluster
String$class: 'Delete'vm
StringfailOnNoExist
boolean$class: 'DeleteSnapshot'vm
StringsnapshotName
Stringconsolidate
booleanfailOnNoExist
boolean$class: 'Deploy'template
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringcustomizationSpec
StringtimeoutInSeconds
intpowerOn
boolean$class: 'ExposeGuestInfo'vm
StringenvVariablePrefix
StringwaitForIp4
boolean$class: 'PowerOff'vm
StringevenIfSuspended
booleanshutdownGracefully
booleanignoreIfNotExists
booleangracefulShutdownTimeout (optional)
int$class: 'PowerOn'vm
StringtimeoutInSeconds
int$class: 'Reconfigure'vm
StringreconfigureSteps
$class: 'ReconfigureAnnotation'annotation (optional)
Stringappend (optional)
boolean$class: 'ReconfigureCpu'cpuCores
StringcoresPerSocket
String$class: 'ReconfigureDisk'diskSize
Stringdatastore
String$class: 'ReconfigureMemory'memorySize
String$class: 'ReconfigureNetworkAdapters'deviceAction
ADD, EDIT, REMOVEdeviceLabel
StringmacAddress
StringstandardSwitch
booleanportGroup
StringdistributedSwitch
booleandistributedPortGroup
StringdistributedPortId
String$class: 'Rename'oldName
StringnewName
String$class: 'RenameSnapshot'vm
StringoldName
StringnewName
StringnewDescription
String$class: 'RevertToSnapshot'vm
StringsnapshotName
String$class: 'SuspendVm'vm
String$class: 'TakeSnapshot'vm
StringsnapshotName
Stringdescription
StringincludeMemory
booleanserverName
String$class: 'VaddyPlugin'host
StringuserId
StringauthKey
StringcrawlId
StringapiServerUrl
StringproxyHost
StringproxyPort
String$class: 'VagrantDestroyCommand'vagrantFile
StringvagrantVm
String$class: 'VagrantProvisionCommand'vagrantFile
StringvagrantVm
Stringprovisioners
Stringparallel
boolean$class: 'VagrantSshCommand'vagrantFile
StringvagrantVm
Stringcommand
StringasRoot
boolean$class: 'VagrantUpCommand'vagrantFile
StringvagrantVm
StringdestroyOnError
booleanprovider
StringdontKillMe
boolean$class: 'ValgrindBuilder'valgrindExecutable
StringworkingDirectory
StringincludePattern
StringexcludePattern
StringoutputDirectory
StringoutputFileEnding
StringprogramOptions
Stringtool
$class: 'ValgrindToolHelgrind'historyLevel
String$class: 'ValgrindToolMemcheck'showReachable
booleanundefinedValueErrors
booleanleakCheckLevel
StringtrackOrigins
booleanvalgrindOptions
StringignoreExitCode
booleantraceChildren
booleanchildSilentAfterFork
booleangenerateSuppressions
booleansuppressionFiles
StringremoveOldReports
booleancrxValidatepackageIdFilters (optional)
**/*.zip
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zip
Matching packages will be validated in the order in which the filters are specified. At least one package must match each filter or the step will fail.
StringallowNonCoveredRoots (optional)
booleanforbiddenACHandlingModeSet (optional)
StringforbiddenExtensions (optional)
.jar
.zip
This field supports parameter tokens.
StringforbiddenFilterRootPrefixes (optional)
/apps/system
/apps/system/config
/apps/systemOfADown/config
StringlocalDirectory (optional)
StringpathsDeniedForInclusion (optional)
/apps/system/rep:policy
/etc/map/http/site_root_redirect
Use this test to safeguard specific paths or possible paths within unrestricted roots from overly broad workspace filters.
StringvalidationFilter (optional)
/etc # define /etc as the filter root
-/etc/packages(/.)? # exclude package paths
This field supports parameter tokens.
String$class: 'Validator'stack
Stringbranch
StringapiKey
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
StringvariablesPrefix
StringvariablesSuffix
StringemptyValue
Stringconfigs
name
Stringvalue
String$class: 'VectorCASTCommand'winCommand
StringunixCommand
String$class: 'VectorCASTSetup'environmentSetupWin
StringenvironmentSetupUnix
StringexecutePreambleWin
StringexecutePreambleUnix
StringenvironmentTeardownWin
StringenvironmentTeardownUnix
StringoptionUseReporting
booleanoptionErrorLevel
StringoptionHtmlBuildDesc
StringoptionExecutionReport
booleanoptionClean
booleanwaitLoops
longwaitTime
longmanageProjectName
StringjobName
StringnodeLabel
String$class: 'ViberNotifier'token (optional)
Stringsender (optional)
Stringmessage (optional)
String$class: 'ViewCloner'url
StringreplacePatternString
StringniewViewName
Stringpassword
Stringusername
String$class: 'VirtualenvBuilder'pythonName
Stringhome
Stringclear
booleansystemSitePackages
booleannature
Stringcommand
StringignoreExitCode
boolean$class: 'VsCodeMetricsBuilder'toolName
Stringfiles
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ assembly file path ]
StringoutputXML
Metrics results XML output file.
Command Line Argument: /out:[ output file path ]
Stringdirectory
Location to search for assembly dependencies.
You can specify multiple directories by separating them with new-line or space.
Command Line Argument: /directory:[ directory ]
StringsearchGac
Search the Global Assembly Cache for missing references.
Command Line Argument: /searchgac
booleanplatform
Location of framework assemblies, such as mscorlib.dll.
Command Line Argument: /platform:[ directory ]
Stringreference
Reference assemblies required for analysis.
You can specify multiple reference assemblies by separating them with new-line or space.
Command Line Argument: /reference:[ assembly file path ]
StringignoreInvalidTargets
Silently ignore invalid target files.
Command Line Argument: /ignoreinvalidtargets
booleanignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleancmdLineArgs
StringfailBuild
booleanvsTestcmdLineArgs (optional)
Stringenablecodecoverage (optional)
Enables data diagnostic adapter CodeCoverage in the test run.
Default settings are used if not specified using settings file.
Command Line Argument: /Enablecodecoverage
booleanfailBuild (optional)
booleanframework (optional)
Target .NET Framework version to be used for test execution.
Valid values are Framework35, Framework40 and Framework45.
Command Line Argument: /Framework: [ framework version ]
StringinIsolation (optional)
Runs the tests in an isolated process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
booleanlogger (optional)
Specify a logger for test results. For example, to log results into a Visual Studio Test Results File (TRX) use /Logger:trx.
Command Line Argument: /Logger:[ uri/friendlyname ]
Stringplatform (optional)
Target platform architecture to be used for test execution.
Valid values are x86, x64 and ARM.
Stringsettings (optional)
Run tests with additional settings such as data collectors.
Example: Local.RunSettings
Command Line Argument: /Settings:[ file name ]
StringtestCaseFilter (optional)
Run tests that match the given expression.
<Expression> is of the format <property>=<value>[||<Expression>].
Example: TestCategory=Nightly||Name=Namespace.ClassName.MethodName
The TestCaseFilter command line option cannot be used with the Tests command line option.
Command Line Argument: /TestCaseFilter:[ expression ]
StringtestFiles (optional)
Specify the path to your VSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line or space.
Stringtests (optional)
Run tests with names that match the provided values.
To provide multiple values, separate them by commas.
Example: TestMethod1,testMethod2
The /Tests command line option cannot be used with the /TestCaseFilter command line option.
Command Line Argument: /Tests:[ test name ]
StringuseVs2017Plus (optional)
This makes adjustments to the arguments for the sake of compatibility with Visual Studio 2017+.
Command Line Argument: /UseVs2017Plus:true
booleanuseVsixExtensions (optional)
This makes vstest.console.exe process use or skip the VSIX extensions installed (if any) in the test run.
Command Line Argument: /UseVsixExtensions:true
booleanvsTestName (optional)
String$class: 'WASBuildStep'additionalClasspath
StringappendTrace
booleancommands
StringjavaOptions
StringjobId
Stringlanguage
StringprofileScriptFiles
StringpropertiesFiles
StringrunIf
true.StringscriptFile
StringscriptParameters
StringtraceFile
StringwasServerName
Stringuser
Stringpassword
String$class: 'WakeUpIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'WarDeployment'apiKey
StringappName
StringwarPath
String$class: 'WarriorPluginBuilder'configType
StringgitConfigUrl
StringgitConfigCredentials
booleangitConfigTagValue
StringgitConfigCloneType
StringgitConfigUname
StringgitConfigPwd
StringgitConfigFile
StringsftpConfigIp
StringsftpConfigUname
StringsftpConfigPwd
StringsftpConfigFile
StringpythonPath
StringuploadExecLog
booleanuploadServerIp
StringuploadServerUname
StringuploadServerPwd
StringuploadServerType
StringuploadServerDir
StringrunFiles
runFile
String$class: 'WebLoadAnalyticsBuilder'inputLsFile
StringportfolioFile
Stringformat
JUNIT, HTML, DOC, ODT, XLS, XLSX, RTF, PDF, CSV, RAWlocation
StringreportName
StringcompareToSessions
StringcompareToPreviousBuilds
int$class: 'WebLoadConsoleBuilder'tplFile
StringlsFile
StringexecutionDuration
longvirtualClients
longprobindClient
long$class: 'WildflyBuilder'war
Stringhost
Stringport
Stringusername
Stringpassword
Stringserver
String$class: 'WinBatchBuildStep'buildStepId
StringscriptBuildStepArgs
defineArgs
booleanbuildStepArgs
arg
String$class: 'WinDocksBuilder'ipaddress
Stringimage
StringwinRMClienthostName
StringcredentialsId
StringwinRMOperations
invokeCommandcommand
StringsendFilesource
Stringdestination
StringconfigurationName
String$class: 'WixToolsetBuilder'sources
StringmarkAsUnstable
booleancompileOnly
booleanuseUiExt
booleanuseUtilExt
booleanuseBalExt
booleanuseComPlusExt
booleanuseDependencyExt
booleanuseDifxAppExt
booleanuseDirectXExt
booleanuseFirewallExt
booleanuseGamingExt
booleanuseIISExt
booleanuseMsmqExt
booleanuseNetfxExt
booleanusePsExt
booleanuseSqlExt
booleanuseTagExt
booleanuseVsExt
booleanmsiOutput
Enter a name for the generated MSI/EXE package. If left blank, the MSI package is named setup.msi. You can also use the file ending *.exe. But keep in mind, that you have to create a Bootstrapper and activeate the BalExtension to create an Executable.
You can use environment variables like $GIT_BRANCH to define a package name.
Stringarch
String$class: 'WorkspaceDeployment'apiKey
StringappName
StringglobIncludes
StringglobExcludes
StringprocfilePath
StringxcodeBuildallowFailingBuildResults (optional)
Checking this option will prevent a build step from failing if xcodebuild exits with a non-zero return code.
This can be useful for build steps that run unit tests and also have a post-build task to publish unit test results: the test step will not fail the entire build for a failing unit test, but will instead mark the build unstable in the "publish test" phase.
booleanappURL (optional)
StringassetPackManifestURL (optional)
StringassetPacksBaseURL (optional)
StringassetPacksInBundle (optional)
booleanbuildDir (optional)
The value to use for the BUILD_DIR setting. You only need to supply this value if you want the product of the Xcode build to be in a location other than the one specified in project settings and this job 'SYMROOT' parameter.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringbuildIpa (optional)
Checking this option will create a .ipa for each .app found in the build directory.
An .ipa is basically a zipped up .app.
This is quite handy for distributing ad-hoc builds to testers as they can just double-click the .ipa and it will import into iTunes.
booleanbundleID (optional)
The new bundle ID. Usually something like com.companyname.projectname.
StringbundleIDInfoPlistPath (optional)
The path to the info.plist file which contains the CFBundleIdentifier of your project.
Usually something like:
StringcfBundleShortVersionStringValue (optional)
This will set the CFBundleShortVersionString to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
StringcfBundleVersionValue (optional)
This will set the CFBundleVersion to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example the value ${BUILD_NUMBER} will be replaced with the current build number.
We advice you to generate a unique value for each build if you want for example deploy it into a private store.
In that case, for example, you can use : ${JOB_NAME}-${BUILD_NUMBER}
StringchangeBundleID (optional)
Checking this option will replace the bundle identifier.
You will need to specify which bundle ID (CFBundleIdentifier) to use and where is the Info.plist file located.
This is handy for example when you want to use a different code signing identity in your development projects.
booleancleanBeforeBuild (optional)
This will delete the build directories before invoking the build. This will force the rebuilding of ALL dependencies and can make large projects take a lot longer.
booleancleanResultBundlePath (optional)
This will delete the ResultBundlePath before invoking the build.
If the directory already exists in the location specified by ResultBundlePath, xcodebuild will be an error and should be checked.
booleancleanTestReports (optional)
booleancompileBitcode (optional)
booleanconfiguration (optional)
This is the name of the configuration as defined in the Xcode project.
By default there are Debug and Release configurations.
StringcopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringgenerateArchive (optional)
Checking this option will create an .xcarchive .app found in the build directory.
An .xcarchive is useful for submission to the app store or third party crash reporters.
You must specify a Scheme to perform an archive.
booleanignoreTestResults (optional)
booleaninterpretTargetAsRegEx (optional)
Build all entries listed under the "Targets:" section of the xcodebuild -list output that match the regexp.
booleanipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainName (optional)
The name of this configured keychain. Each job will specify a keychain configuration by the name.
StringkeychainPath (optional)
The path of the keychain to use to retrieve certificates to sign the package (default : ${HOME}/Library/Keychains/login.keychain).
StringkeychainPwd (optional)
The password of the keychain to use to retrieve certificates to sign the package.
hudson.util.Secret
logfileOutputDirectory (optional)
Specify the directory to output the log of xcodebuild.
If you leave it blank, it will be output to "project directory/builds/${BUILD_NUMBER}/log" with other logs.
If an output path is specified, it is output as a xcodebuild.log file in a relative directory under the "build output directory"
StringmanualSigning (optional)
booleannoConsoleLog (optional)
booleanprovideApplicationVersion (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresultBundlePath (optional)
Specify the directory to output the output the test result.
If you leave it blank, it will not output a test result and will not analyze the test results.
If an output path is specified, it is output as a test result in a relative directory under the "ResultBundlePath".
The plug-in analyzes the test result here and outputs a JUnit compatible XML file under the ${WORKSPACE}/test-reports.
Stringsdk (optional)
You only need to supply this value if you want to specify the SDK to build against. If empty, the SDK will be determined by Xcode. If you wish to run OCUnit tests, you will need to use the iPhone Simulator's SDK, for example:
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.1.sdk/
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
You only need to supply this value if you want to specify the SYMROOT path to use.
If empty, the default SYMROOT path will be used (it could be different depending of your Xcode version).
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/symroot
Stringtarget (optional)
The target to build. If left empty, this will build all targets in the project.
If you wish to build your binary and the unit test module, it is best to do this as two separate steps each with their own target.
This was, the iPhone Simulator SDK can be specified for the unit tests.
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanuseLegacyBuildSystem (optional)
Instead of "New Builld System" which became available from Xcode 9, we build the application using the legacy build system.
There is a possibility that you can handle old projects that cause problems with the new build system.
Also, since new output formats of logs are changed in the new build system, it is also useful when you want to handle logs with legacy third party tools.
booleanxcodeName (optional)
StringxcodeProjectFile (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringxcodebuildArguments (optional)
Extra xcodebuild parameters, added after the command that jenkins generates based on the rest of the config
String$class: 'XFramiumBuilder'configFile
StringsuiteName
StringtestNames
StringtagNames
StringstepTags
StringdeviceTags
StringdefaultCloud
StringoverrideDefaults
boolean$class: 'XLRVarSetterBuilder'XLR_releaseId
StringXLR_varName
StringJKS_varName
Stringdebug
booleanosfBuilderSuiteXMLLintxsdsPath (optional)
StringxmlsPath (optional)
StringreportPath (optional)
String$class: 'XShellBuilder'commandLine
StringexecuteFromWorkingDir
booleanregexToKill
StringtimeAllocated
String$class: 'XUnitBuilder'tools
AUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanBoostTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCheckpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'CpptestPluginType'pattern
StringfailIfNotNew
booleandeleteOutputFiles
booleanCustompattern
StringcustomXSL
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanembUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanFPCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleangtesterpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'GallioPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanGoogleTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'JSUnitPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanJUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMSTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMbUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit3pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit2pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanPHPUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftSOAtest9xType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanQtTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'SCTMTestType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanUnitTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanValgrindpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanxUnitDotNetpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'hudson.plugins.testcomplete.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
String$class: 'jenkins.plugins.xunit.tc11.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
Stringthresholds
failedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringpassedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringskippedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringthresholdMode
inttestTimeMargin
StringreduceLog (optional)
boolean$class: 'ZAPBuilder'startZAPFirst
booleanzapHost
StringzapPort
Stringzaproxy
autoInstall
booleantoolUsed
StringzapHome
Stringjdk
Stringtimeout
intzapSettingsDir
StringautoLoadSession
booleanloadSession
StringsessionFilename
StringremoveExternalSites
booleaninternalSites
StringcontextName
StringincludedURL
StringexcludedURL
StringalertFilters
StringauthMode
booleanusername
Stringpassword
StringloggedInIndicator
StringloggedOutIndicator
StringauthMethod
StringloginURL
StringusernameParameter
StringpasswordParameter
StringextraPostData
StringauthScript
StringauthScriptParams
scriptParameterName
StringscriptParameterValue
StringtargetURL
StringspiderScanURL
booleanspiderScanRecurse
booleanspiderScanSubtreeOnly
booleanspiderScanMaxChildrenToCrawl
intajaxSpiderURL
booleanajaxSpiderInScopeOnly
booleanactiveScanURL
booleanactiveScanRecurse
booleanactiveScanPolicy
StringgenerateReports
booleanselectedReportMethod
StringdeleteReports
booleanreportFilename
StringselectedReportFormats
StringselectedExportFormats
StringexportreportTitle
StringexportreportBy
StringexportreportFor
StringexportreportScanDate
StringexportreportReportDate
StringexportreportScanVersion
StringexportreportReportVersion
StringexportreportReportDescription
StringexportreportAlertHigh
booleanexportreportAlertMedium
booleanexportreportAlertLow
booleanexportreportAlertInformational
booleanexportreportCWEID
booleanexportreportWASCID
booleanexportreportDescription
booleanexportreportOtherInfo
booleanexportreportSolution
booleanexportreportReference
booleanexportreportRequestHeader
booleanexportreportResponseHeader
booleanexportreportRequestBody
booleanexportreportResponseBody
booleanjiraCreate
booleanjiraProjectKey
StringjiraAssignee
StringjiraAlertHigh
booleanjiraAlertMedium
booleanjiraAlertLow
booleanjiraFilterIssuesByResourceType
booleancmdLinesZAP
cmdLineOption
StringcmdLineValue
String$class: 'ZOSJobSubmitter'server
Stringport
intcredentialsId
Stringwait
booleanwaitTime
intdeleteJobFromSpool
booleanjobLogToConsole
booleanjobFile
StringMaxCC
StringJESINTERFACELEVEL1
boolean$class: 'ZanataCliBuilder'projFile
StringsyncG2zanata
booleansyncZ2git
booleanzanataCredentialsId
StringextraPathEntries (optional)
String$class: 'ZanataSyncStep'zanataCredentialsId
StringpullFromZanata (optional)
booleanpushToZanata (optional)
booleansyncOption (optional)
StringzanataLocaleIds (optional)
StringzanataProjectConfigs (optional)
StringzanataURL (optional)
String$class: 'ZapRunner'host
StringzapInstallDescription
value
Stringpath
StringrepositoryURL
StringsourcePath
StringzulipSendmessage (optional)
Stringstream (optional)
Stringtopic (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncApiToken (optional)
StringncProfileId (optional)
StringncServerURL (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.alauda.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.aliyun.www.cos.DeployBuilder'masterurl
StringappName (optional)
StringcomposeTemplate (optional)
StringcredentialsId (optional)
StringpublishStrategy (optional)
String$class: 'com.cloudbees.dockerpublish.DockerBuilder'repoName
StringbuildAdditionalArgs (optional)
StringbuildContext (optional)
StringcreateFingerprint (optional)
booleandockerToolName (optional)
StringdockerfilePath (optional)
StringforcePull (optional)
booleanforceTag (optional)
booleannoCache (optional)
booleanregistry (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringrepoTag (optional)
Stringserver (optional)
uri
unix:///var/run/docker.sock or
tcp://127.0.0.1:2376).
StringcredentialsId
StringskipBuild (optional)
booleanskipDecorate (optional)
booleanskipPush (optional)
booleanskipTagLatest (optional)
boolean$class: 'com.cloudbees.plugins.deployer.DeployBuilder'hosts
?>
$class: 'com.etas.jenkins.plugins.CreateTextFile.CreateFileBuilder'textFilePath
StringtextFileContent
StringfileOption
StringuseWorkspace
boolean$class: 'com.groupon.jenkinsci.plugins.DotCiFigtemplate.HelloWorldBuilder'name
StringNCScanBuilderncScanType
StringncWebsiteId
StringncApiToken (optional)
StringncProfileId (optional)
StringncServerURL (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.openshift.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.perfectomobile.jenkins.copyartifact.CopyArtifact'projectName
Stringparameters
Stringselector
$class: 'ParameterizedBuildSelector'parameterName
String$class: 'PermalinkBuildSelector'id
String$class: 'SavedBuildSelector'$class: 'SpecificBuildSelector'buildNumber
String$class: 'StatusBuildSelector'stableOnly
boolean$class: 'TriggeredBuildSelector'fallback
boolean$class: 'WorkspaceSelector'filter
Stringtarget
Stringflatten
booleanoptional
booleanfingerprintArtifacts
booleanautoMedia
String$class: 'com.quest.tdt.ScriptBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringscript
Stringfile
The full file path including name and extension of the SQL file to execute. Please note that this is relative to the machine running the job.
StringsourceType
StringoutputName
StringlimitMaxRows
StringmaxRows
The maximum number of returned rows if any rows are to be returned.
int$class: 'com.synopsys.integration.jenkins.coverity.extensions.buildstep.CoverityBuildStep'coverityInstanceUrl
Specify which Synopsys Coverity connect instance to run this job against.
The resulting Synopsys Coverity connect instance URL is stored in the $COV_URL environment variable, and will affect both the full and incremental analysis.
StringonCommandFailure
Specify the action to take if a Coverity static analysis command fails.
StringprojectName
Specify the name of the Coverity project.
The resulting project name is stored in the $COV_PROJECT environment variable, and will affect both the full and incremental analysis.
StringstreamName
Specify the name of the Coverity stream that you would like to use for the commands.
The resulting stream name is stored in the $COV_STREAM environment variable, and will affect both the full and incremental analysis.
StringcheckForIssuesInView
viewName
Specify the name of the Coverity view that you would like to check for issues.
The resulting view name is stored in the $COV_VIEW environment variable, and affects checking for issues in both the full and incremental analysis, if configured.
StringbuildStatusForIssues
Specify the build status to set if issues are found in the configured view.
StringconfigureChangeSetPatterns
changeSetExclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be excluded |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringchangeSetInclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly included from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be included |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringcoverityRunConfiguration
$class: 'AdvancedCoverityRunConfiguration'commands
command
Provide the Coverity command you want to run.
The command should start with the name of the Coverity command you want to run. Ex: cov-build, cov-analyze, etc.
For examples and a list of the available environment variables that can be used, refer to Command Examples
String$class: 'SimpleCoverityRunConfiguration'coverityAnalysisType
Specify the type of analysis you would like to run.
Full Analysis will run the cov-build, cov-analyze, and cov-commit-defects commands (in that order)
Incremental Analysis will run the cov-build, cov-run-desktop, and cov-commit-defects commands (in that order)
Specifically, the commands will be invoked with the following parameters:
| cov-build --dir ${WORKSPACE}/idir build command |
| cov-analyze --dir ${WORKSPACE}/idir |
| cov-run-desktop --dir ${WORKSPACE}/idir --url ${COV_URL} ${CHANGE_SET} |
| cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM} |
COV_ANALYZE, COV_RUN_DESKTOPbuildCommand
StringcommandArguments
covBuildArguments
Specify additional arguments to apply to the invocation of the cov-build command. Affects full and incremental analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
build command
StringcovAnalyzeArguments
Specify additional arguments to apply to the invocation of the cov-analyze command. Affects full analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
StringcovRunDesktopArguments
Specify additional arguments to apply to the invocation of the cov-run-desktop command. Affects incremental analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
--url ${COV_URL}
--stream ${COV_STREAM}
${CHANGE_SET}
StringcovCommitDefectsArguments
Specify additional arguments to apply to the invocation of the cov-commit-defects command. Affects both full and incremental analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
--url ${COV_URL}
--stream ${COVERITY_STREAM}
String$class: 'eggPlantBuilder'script
Relative to the Execution Directory, specify the script or scripts, separated by commas to execute in the test relative to the workspace directory for this job, for example:
NOTE: To have scripts run against different SUTs, it is necessary to create a build step for each SUT.
StringSUT
Stringport
Set the VNC Server port for the SUT, eg. 5900. Leaving this blank will use the default port for VNC, 5900.
Stringpassword
Specifies the password for the VNC server. If there's no password, this field can be left blank.
StringcolorDepth
StringglobalResultsFolder
OPTIONAL. Specify the path to the global results folder, relative to the workspace.
StringdefaultDocumentDirectory
Specify the path to the Default Document Directory, relative to the Execution Directory. See Running Eggplant From the Command Line in the Eggplant documentation
Stringparams
Parameters to be passed to the script(s). Equivalent to the -params flag when executing from the command line.
StringreportFailures
booleancommandLineOutput
Pipe eggPlant results out as part of the console output.
booleaninstallationName
StringcopyArtifactsprojectName
The name of the project to copy artifacts from.
Artifacts from all modules will be copied. Enter JOBNAME/MODULENAME here to copy from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins.
Example: MyMavenJob/my.group$MyModule
Artifacts from all configurations will be copied, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins.
Example: If the target directory is given as fromMatrix then the copy could create $WORKSPACE/fromMatrix/label=slaveA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=slaveB/dist/mybuild.jar.
To copy from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration.
Example: MyMatrixJob/jdk=Java6u17
To copy artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project.
Example: OtherMatrixJob/jdk=$jdk
Use a path consisting of the project name followed by the branch name.
Example: /MyMultibranchProject/MyBranch
Special letters like '/' in branch names should be escaped. You can see the exact name in "Full project name" in job pages of each branch.
Example: ../MyMultibranchProject/feature%2Fnavigation
See the wiki page "How to reference another project by name" for more information.
Stringexcludes (optional)
Stringfilter (optional)
StringfingerprintArtifacts (optional)
booleanflatten (optional)
booleanoptional (optional)
booleanparameters (optional)
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.
StringresultVariableSuffix (optional)
If not specified, the source project name will be used instead (in all uppercase, and sequences of characters other than A-Z replaced by a single underscore).
Example:
| Source project name | Suffix to be used |
|---|---|
| Project-ABC | PROJECT_ABC |
| tool1-release1.2 | TOOL_RELEASE_ |
Stringselector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacetarget (optional)
String$class: 'iOSAppInstaller'url
StringcloudTestServerID
Stringipa
StringadditionalOptions
String$class: 'iOSSimulatorLauncher'url
StringcloudTestServerID
Stringapp
Stringsdk
Stringfamily
String$class: 'jenkins.plugins.coverity.CoverityBuildStep'The build step can be configured as any other build steps. Choose the appropriate builder and configure the command to be performed. The configured build step will be wrapped with the Coverity cov-build executables so that it captures the build and can be used to further analysis by using coverity static tools. This build step is only for capturing build of compiled sources.
buildStep
$class: 'org.jenkinsci.plugins.dockerbuildstep.DockerBuilder'dockerCmd
$class: 'CommitCommand'containerId
Stringrepo
Stringtag
StringrunCmd
String$class: 'CreateContainerCommand'image
Stringcommand
StringhostName
StringcontainerName
StringenvVars
Stringlinks
StringexposedPorts
StringcpuShares
StringmemoryLimit
Stringdns
StringextraHosts
StringpublishAllPorts
This setting corresponds to the --publish-all (-P) option of the docker run CLI command.
booleanportBindings
--publish (
-p) option of the
docker run CLI command.
Enter one or more port binding, each on its own line. The syntax is host container where host is either hostPort or hostIp:hostPort and container is either containerPort or containerPort/protocol.
Alternatively, you can separate host and port with a colon (":"), thus using the same syntax as in the Docker CLI.
Examples
StringbindMounts
--volume (
-v) option of the
docker run CLI command.
Enter one or more bind mount, each on its own line. The syntax is hostPath containerPath[ rw|ro]
Stringprivileged
This setting corresponds to the --privileged option of the docker run CLI command.
booleanalwaysRestart
boolean$class: 'CreateImageCommand'dockerFolder
StringimageTag
StringdockerFile
StringnoCache
booleanrm
booleanbuildArgs
String$class: 'ExecCreateAndStartCommand'containerIds
Stringcommand
String$class: 'ExecCreateCommand'containerIds
Stringcommand
String$class: 'ExecStartCommand'commandIds
String$class: 'KillCommand'containerIds
String$class: 'PullImageCommand'fromImage
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'PushImageCommand'image
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'RemoveAllCommand'removeVolumes
booleanforce
boolean$class: 'RemoveCommand'containerIds
StringignoreIfNotFound
booleanremoveVolumes
booleanforce
boolean$class: 'RemoveImageCommand'imageName
StringimageId
StringignoreIfNotFound
boolean$class: 'RestartCommand'containerIds
Stringtimeout
int$class: 'SaveImageCommand'imageName
StringimageTag
Stringdestination
Stringfilename
StringignoreIfNotFound
boolean$class: 'StartByImageIdCommand'imageId
String$class: 'StartCommand'containerIds
StringwaitPorts
StringcontainerIdsLogging
String$class: 'StopAllCommand'$class: 'StopByImageIdCommand'imageId
String$class: 'StopCommand'containerIds
String$class: 'TagImageCommand'image
Stringrepository
Stringtag
StringignoreIfNotFound
booleanwithForce
boolean$class: 'org.jenkinsci.plugins.ios.connector.DeployBuilder'path
Stringudid
(We are looking for more ways to let you specify the target device flexibly. Please send in your suggestions.)
String$class: 'org.jenkinsci.plugins.lsf.BatchBuilder'job
StringfilesToDownload
StringdownloadDestination
StringfilesToSend
StringcheckFrequencyMinutes
intsendEmail
booleanosfBuilderSuiteForSFCCDeployhostname (optional)
StringbmCredentialsId (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringbuildVersion (optional)
StringcreateBuildInfoCartridge (optional)
booleanactivateBuild (optional)
booleansourcePaths (optional)
sourcePath
StringexcludePatterns
excludePattern
StringtempDirectory (optional)
Stringgreetname
StringuseFrench (optional)
boolean$class: 'org.jenkinsci.plugins.sge.BatchBuilder'job
StringfilesToDownload
StringdownloadDestination
StringfilesToSend
StringcheckFrequencyMinutes
floatsendEmail
boolean$class: 'org.jenkinsci.plugins.spoontrigger.ScriptBuilder'scriptFilePath
StringcredentialsId
StringhubUrl
StringimageName
StringvmVersion
StringcontainerWorkingDir
StringmountSettings
sourceContainer
StringsourceFolder
StringtargetFolder
StringrouteFile
StringnoBase
booleanoverwrite
booleandiagnostic
boolean$class: 'org.jenkinsci.plugins.trial_balloon.HelloWorldBuilder'name
String$class: 'org.quality.gates.jenkins.plugin.QGBuilder'jobConfigData
org.quality.gates.jenkins.plugin.JobConfigData
globalConfigDataForSonarInstance
org.quality.gates.jenkins.plugin.GlobalConfigDataForSonarInstance
$class: 'quality.gates.jenkins.plugin.QGBuilder'jobConfigData
quality.gates.jenkins.plugin.JobConfigData
$class: 'vRABlueprintBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringpackageBlueprint
booleanblueprintPath
StringoverWrite
booleanpublishBlueprint
booleanserviceCategory
String$class: 'vRADeploymentBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringblueprintName
StringwaitExec
booleanrequestTemplate
booleanrequestParams
json
String$class: 'ConditionalBuilder'runCondition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringrunner
A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false.
$class: 'DontRun'$class: 'Fail'$class: 'Run'$class: 'RunUnstable'$class: 'Unstable'conditionalbuilders
$class: 'ConfigAdd'apiKey
StringappName
StringconfigVars
String$class: 'ConfigFileBuildStep'managedFiles
fileId
Name of the file.
StringreplaceTokens (optional)
Decides whether the token should be replaced using macro.
booleantargetLocation (optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
Stringvariable (optional)
Name of the variable which can be used as the reference for further configuration.
String$class: 'ConfluenceReleaseNotesPublisher'jiraCredentialsID
StringconfluenceCredentialsID
StringspaceKey
StringjqlFilter
StringpageTitle
StringparentPageTitle
String$class: 'ConsulBuilder'installationName
StringoperationList
$class: 'ConsulGetKV'valuePath
StringenvironmentVariableName
String$class: 'ConsulServiceDiscoveryOperation'serviceName
StringserviceTag
StringenvironmentVariableName
StringhealthStatus
StringaddPort
boolean$class: 'ConsulSetKV'valuePath
Stringvalue
StringconsulSettingsProfileName
String$class: 'ConsulKVBuilder'hostUrl
Stringkey
StringaclToken (optional)
StringapiUri (optional)
StringdebugMode (optional)
ENABLED, DISABLEDenvVarKey (optional)
StringignoreGlobalSettings (optional)
booleankeyValue (optional)
StringrequestMode (optional)
READ, WRITE, DELETEtimeoutConnection (optional)
inttimeoutResponse (optional)
intassessContainerImagefailOnPluginError (optional)
booleanimageId (optional)
StringnameRules (optional)
packageNameaction
Stringcontains
StringvulnerabilityCategoryaction
Stringcontains
StringvulnerabilityTitleaction
Stringcontains
StringvulnerablePackageNameaction
Stringcontains
StringthresholdRules (optional)
criticalVulnerabilitiesaction
Stringthreshold
StringcvssV2Scoreaction
Stringthreshold
StringexploitableVulnerabilitiesaction
Stringthreshold
StringvulnerabilitiesWithMalwareKitsaction
Stringthreshold
StringmoderateVulnerabilitiesaction
Stringthreshold
StringpackageRiskScoreaction
Stringthreshold
StringriskScoreaction
Stringthreshold
StringsevereVulnerabilitiesaction
Stringthreshold
StringtotalVulnerabilitiesaction
Stringthreshold
StringtreatWarningsAsErrors (optional)
booleanworkspaceDir (optional)
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
Stringconfigs
search
Stringreplace
StringmatchCount
int$class: 'ContinuousReleaseProperties'properties
java.lang.String>
$class: 'CoordinatorBuilder'executionPlan
org.jenkinsci.plugins.coordinator.model.TreeNode
$class: 'CopadoBuilder'stepName
StringwebhookUrl
Stringapi_key
Stringtimeout
intcopydstFile (optional)
StringkeepMeta (optional)
booleanrecursive (optional)
booleansrcFile (optional)
String$class: 'CreateBaselineBuilder'outputFile
Path to the file that should be used to store baseline.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating baseline. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'CreateFingerprint'Create Fingerprints of specified files during a build process
targets
String$class: 'CreatePackageBuilder'Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_PACKAGE_NUMBER environment variable.
The choice of using the build step or post build action to trigger a BuildMaster build will be largely dependent on how you import the build artifacts into BuildMaster:
If you have multiple Jenkins jobs all triggering a build for the same BuildMaster application check out the "Enable Deployable in BuildMaster" and "Copy Previous Build's Variables" options as a means to ensure that the new BuildMaster build picks up artifacts from only the Jenkins jobs that have build for its release.
applicationId (optional)
StringdeployToFirstStage (optional)
waitUntilDeploymentCompleted
booleanprintLogOnFailure (optional)
booleanenableReleaseDeployable (optional)
If the BuildMaster deployable that these artifacts are associated with are disabled by default for a release checking this option will enable the deployable for the release before triggering a build.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
deployableId
The id of the deployable to ensure is enabled in BuildMaster for the selected release. Defaults to the BUILDMASTER_DEPLOYABLE_ID variable populated by the "Select BuildMaster Application" action.
StringpackageNumber (optional)
The number that BuildMaster should use for the build. Defaults to the BUILDMASTER_PACKAGE_NUMBER variable populated by the "Select BuildMaster Application" action. Leave the field blank to have BuildMaster use it's own BuildNumber - the BUILDMASTER_PACKAGE_NUMBER will be set to the actual BuildMaster build number used in this instance.
If supplying a build number to BuildMaster and the build will fail with a BadRequest exception if an attempt is made to reuse a build number from a previous build. If this happens you will need to update the Jenkins build number to something greater than the latest BuildMaster build - there is a plugin to help with that: Next Build Number Plugin.
NOTE: to retain backwards compatibility BUILDMASTER_PACKAGE_NUMBER has not been updated to reflect the new naming standard from BuildMaster - this may change in a future release
StringpackageVariables (optional)
Set build level variables.
variables
Provide a list of variables to pass to BuildMaster.
StringpreserveVariables (optional)
If checked will gather the variables from the previous build and include them in the list of variables being passed in for this build, these will not override any variables being added in the Variables list below.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
booleanreleaseNumber (optional)
String$class: 'CreateSnapshotBuilder'outputFile
Path to the file that should be used to store snapshots.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
Folder/file location must be specified as:
StringcreateTagnexusInstanceId
StringtagName
StringtagAttributesJson (optional)
StringtagAttributesPath (optional)
String$class: 'CreateTemplate'cloud
Stringworkspace
StringinstanceTags
StringtemplateName
Stringprovider
Stringdatacenter
Stringfolder
Stringdatastore
StringclaimFilter
StringpolicyName
Stringclaims
String$class: 'CreateTunnelBuilder'srfTunnelName
String$class: 'CriticalBlockEnd'Release all resources that Critical block start had allocated for this job.
$class: 'CriticalBlockStart'Delimite the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
cryptomovename
Stringtoken
String$class: 'CucumberSlackBuildStepNotifier'channel
Stringjson
StringhideSuccessfulResults
boolean$class: 'CustomPythonBuilder'home
Stringnature
Stringcommand
StringignoreExitCode
boolean$class: 'CxScanBuilder'credentialsId
StringbuildStep
StringteamPath
StringsastEnabled
booleanexclusionsSetting
StringfailBuildOnNewResults
booleanfailBuildOnNewSeverity
StringosaArchiveIncludePatterns
StringosaInstallBeforeScan
booleanuseOwnServerCredentials (optional)
booleanserverUrl (optional)
Stringusername (optional)
Stringpassword (optional)
StringprojectName (optional)
StringprojectId (optional)
longgroupId (optional)
Stringpreset (optional)
StringjobStatusOnError (optional)
GLOBAL, FAILURE, UNSTABLEpresetSpecified (optional)
booleanexcludeFolders (optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
StringfilterPattern (optional)
Example: **/*.java, **/*.html, !**\test\**\XYZ*
Pattern Syntax
A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.separators at the beginning of the pattern and the string to match:
When a pattern starts with a File.separator, the string to match must also start with a File.separator. When a pattern does not start with a File.separator, the string to match may not start with a File.separator. When one of these rules is not obeyed, the string will not match.
When a name path segment is matched against a pattern path segment, the following special characters can be used:
'*' matches zero or more characters
'?' matches one character.
May reference build parameters like ${PARAM}.
Examples:
"**\*.class" matches all .class files/dirs in a directory tree.
"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test.
"**" matches everything in a directory tree.
"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
Stringincremental (optional)
booleanfullScansScheduled (optional)
booleanfullScanCycle (optional)
intsourceEncoding (optional)
Stringcomment (optional)
StringskipSCMTriggers (optional)
booleanwaitForResultsEnabled (optional)
booleanvulnerabilityThresholdEnabled (optional)
booleanhighThreshold (optional)
intmediumThreshold (optional)
intlowThreshold (optional)
intosaEnabled (optional)
booleanosaHighThreshold (optional)
intosaMediumThreshold (optional)
intosaLowThreshold (optional)
intgeneratePdfReport (optional)
booleanenableProjectPolicyEnforcement (optional)
booleanthresholdSettings (optional)
StringvulnerabilityThresholdResult (optional)
StringincludeOpenSourceFolders (optional)
Include/Exclude definition will not affect dependencies resolved from package manager manifest files.
Comma separated list of include or exclude wildcard patterns. Exclude patterns start with exclamation mark "!". Example: *.jar */folder/* */folder1/folder2/* */folder*/* */file.* */file*.jar */test/*file*.*
May reference build parameters like ${PARAM}.
Examples:
"**/*.jar" matches all .jar jars in a directory tree.
"*/test/a??.jar" matches all files/dirs which start with an 'a', then two more characters and then ".jar", in a directory called test.
"**" matches everything in a directory tree.
"**/test/**/XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc/test/def/ghi/XYZ123").
StringexcludeOpenSourceFolders (optional)
StringavoidDuplicateProjectScans (optional)
booleangenerateXmlReport (optional)
booleanthisBuildIncremental (optional)
booleanosfBuilderSuiteForSFCCDataImporthostname (optional)
StringbmCredentialsId (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringarchiveName (optional)
StringsourcePath (optional)
StringincludePatterns (optional)
includePattern
StringexcludePatterns (optional)
excludePattern
StringimportStrategy (optional)
StringtempDirectory (optional)
String$class: 'DatabaseDocBuilder'outputDirectory (optional)
StringbasePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
Stringurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
String$class: 'DaticalDBBuilder'daticalDBProjectDir
StringdaticalDBServer
StringdaticalDBAction
StringdaticalDBCmdProject
StringdaticalDBExportSQL
StringdaticalDBExportRollbackSQL
StringdaticalDBScriptDir
String$class: 'DebianPackageBuilder'pathToDebian
StringnextVersion
StringgenerateChangelog
booleansignPackage
booleanbuildEvenWhenThereAreNoChanges
booleandebianPbuilderadditionalBuildResults (optional)
When running a build in the chroot environment, there are occasionally files that you must retrieve from the chroot that are not part of the normal build. For example, some files that you may need to get back would include test results, auto-generated files, etc.
Set this variable in order to get the files back from the chroot build environment.
The files that are retrieved will also automatically be archived as well with the other build results.
This must be a comma-separated list; spaces are allowed.
Stringarchitecture (optional)
The architecture to build this as.
If the project is using the Matrix Build plugin, leave this blank (the architectures to build for are defined by the 'architecture' environment variable).
This is mostly to support Pipeline, however it can be used as a normal parameter as well.
StringbuildAsTag (optional)
Set this to mark this as building a tag. When a build comes from a tag, the deb version does not get incremented(i.e. it is exactly as set in the debian/changelog file). If using SVN, this plugin automatically looks at the SVN_URL_1 environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. If using Git, this plugin automatically looks at the GIT_BRANCH environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. Alternatively, you can also set the environment variable DEB_PBUILDER_BUILDING_TAG to either true or false.
booleancomponents (optional)
The components to build with. By default, pbuilder sets this to 'main'. If you're building an Ubuntu package, you may need to set this to "main restricted universe multiverse"
The setting guessComponents must be false for this setting to be honored.
StringdebianDirLocation (optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
Stringdistribution (optional)
The distribution to build for. By default, this checks the distribution that is set in debian/changelog. If the version in the changelog is UNRELEASED, it attempts to use the currently running distribution if this parameter is NULL or a 0-length string.
StringguessComponents (optional)
If set to true, automatically try to guess the components. This means that if we think we are building an Ubuntu package on Debian, our components will be automatically set to "main restricted universe multiverse"
booleankeyring (optional)
The keyring to build with. By default, we will attempt to figure out if we are building a Debian package on Ubuntu, and if we think that we are this will be set to /usr/share/keyrings/debian-archive-keyring.gpg. This file is part of the debian-archive-keyring package. If you need to use a custom keyring, put it in here. If for some reason the auto-detection is not working properly, set this to the string 'disabled' and no keyring settings for pbuilder will be set.
StringmirrorSite (optional)
The mirror site to use. If this is not set or a 0-length string, then the default mirror site for this distribution will be used. The default mirror site is defined in /etc/pbuilderrc
StringnumberCores (optional)
The number of cores to use when building. By default, this is 1. Set to -1 in order to use as many cores as possible when building. In order for this to take effect, you need to make sure that your debian/rules is setup properly. See this post.
intpristineTarName (optional)
If this field set, and if source/format indicates that this is a quilt package, we will attempt to checkout the given original tar file.
String$class: 'DeleteApplication'serverName
StringappName
Stringdomain
String$class: 'DeleteChartBuildStep'id
StringkubeName
Stringnamespace
StringchartsRepo
StringchartName
StringdeleteComponentsnexusInstanceId
StringtagName
String$class: 'DeleteEnvironmentBuilder'systemId
intenvironmentName
String$class: 'DeleteVirtualizeBuilder'serverType
StringserverHost
StringserverName
StringdependencyCheckadditionalArguments (optional)
StringodcInstallation (optional)
StringskipOnScmChange (optional)
booleanskipOnUpstreamChange (optional)
boolean$class: 'DeployApplication'This plugin creates a container on the OpenShift PaaS and deploys the application into the container.
serverName
StringappName
Stringcartridges
Specify a space delimited list of cartridges to be assigned to the application. e.g. jbosseap-6 mysql-5.5
Note that the specified cartridges need to be available on the selected OpenShift server. For a complete list of available cartridges on OpenShift refer to OpenShift web console or use the command line too 'rhc cartridges'. Here is the list of some of the most common cartridges:
Stringdomain
StringgearProfile
StringdeploymentPackage
In case of URL or when only one deployment package exists in the given directory, the package is deployed under the root ("/") context. When multiple packages are found, all are deployed under their own context paths.
Token macro expressions can be used for specifying a URL:
https://repo/nexus/service/local/artifact/maven/redirect?r=central&g=${ENV,var="GROUPID"}&a=${ENV,var="ARTIFACTID"}&v=${ENV, var="VERSION"}&e=war
Check Token Macro Plugin for further details.
StringenvironmentVariables
Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
StringautoScale
booleandeploymentType
GIT, BINARYopenshiftDirectory
String$class: 'DeployBox'id
Stringcloud
Stringworkspace
Stringbox
StringboxVersion
StringinstanceName
Stringprofile
Stringclaims
Stringprovider
Stringlocation
StringinstanceEnvVariable
Additional instance properties will also be available via other environment variables that have the defined variable as prefix of their name. For example, if INSTANCE is specified for this field then the following environment variables are available:
INSTANCE - ID of the deployed instance
INSTANCE_URL - URL of the deployed instance
INSTANCE_SERVICE_ID - service ID of the deployed instance
INSTANCE_TAGS - comma-separate list of tags of the deployed instance
If 1 is specified for Number of Instances then the following environment variables are available:
INSTANCE_MACHINE_NAME - VM name of the deployed instance
INSTANCE_PUBLIC_ADDRESS - VM public address of the deployed instance
INSTANCE_PRIVATE_ADDRESS - VM private address of the deployed instance
If Number of Instances is greater than 1, the following environment variable are available:
INSTANCE_MACHINE_NAMES - space-separate list of VM names
INSTANCE_PUBLIC_ADDRESSES - space-separate list of public addresses of the VMs
INSTANCE_PRIVATE_ADDRESSES - space-separate list of private addresses of the VMs
Stringtags
Stringvariables
Stringexpiration
$class: 'AlwaysOn'$class: 'ShutDown'hours
Stringdate
Stringtime
String$class: 'Terminate'hours
Stringdate
Stringtime
StringautoUpdates
StringalternateAction
StringwaitForCompletion
booleanwaitForCompletionTimeout
intboxDeploymentType
StringsamDeploysettings
credentialsId
Stringregion
Strings3Bucket
StringstackName
StringtemplateFile
template.yaml
app/template.json
StringkmsKeyId (optional)
StringoutputTemplateFile (optional)
template-#jobId.yaml by default.
Stringparameters (optional)
key
Stringvalue
StringroleArn (optional)
Strings3Prefix (optional)
Stringtags (optional)
key
Stringvalue
String$class: 'DeployChartBuildStep'id
StringkubeName
Stringnamespace
StringchartsRepo
StringchartName
StringdeleteChartWhenFinished
booleancrxDeploypackageIdFilters (optional)
**/*.zip
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zip
Matching packages will be uploaded in the order in which the filters are specified. Only the highest matching version of a package identified by 'group:name' will be deployed, and it will only be deployed once per build step, regardless of the number of matching filters.
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringacHandling (optional)
Stringautosave (optional)
intbehavior (optional)
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringdisableForJobTesting (optional)
booleanlocalDirectory (optional)
Stringrecursive (optional)
booleanreplicate (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
long$class: 'DeployPromotionBuilder'hosts
?>
$class: 'DeployScriptBuilder'out
Specify full path to target connection file.
File location must be specified as:
Stringin
Specify path to file that contains SQL script.
File location must be specified as:
StringbuildMasterDeployPackageToStageDeploys (or re-deploys) a build to a particular stage.
Note that when used in a pipeline step that the applicationdId, releaseNumber, and packageNumber fields are required:
buildMasterDeployPackageToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, packageNumber: BUILDMASTER_PACKAGE_NUMBER, waitTillBuildCompleted: [printLogOnFailure: true])
applicationId (optional)
This setting would only be altered if not using the "Select BuildMaster Application" action.
StringdeployVariables (optional)
Set deployment level variables.
variables
Provide a list of variables to pass to BuildMaster.
StringpackageNumber (optional)
The job will fail if there is no active BuildMaster release.
This setting would only be altered if not using the "Select BuildMaster Application" action.
StringprintLogOnFailure (optional)
booleanreleaseNumber (optional)
Stringstage (optional)
Optional. If not supplied, the next stage in the pipeline will be used.
StringwaitUntilDeploymentCompleted (optional)
boolean$class: 'Deployer'stack
StringdryRun
booleanbranch
StringapiKey
String$class: 'DeploymentBuilder'url
StringuserId
Stringpassword
StringenableZipFile
booleanenableAutoDeploy
booleanenableTestCase
testcaseblock
projectname
Stringtestcasename
Stringxpath
String$class: 'DescriptionSetterBuilder'This plugin automatically sets a description for the build as a step during building.
A description can be based on the log output (by searching it using a regular expression), or it can be hardcoded.
The description is exposed as DESCRIPTION_SETTER_DESCRIPTION environment variable
regexp
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
Stringdescription
StringdevSpacesCreateazureCredentialsId
StringaksName (optional)
StringkubeconfigId (optional)
StringresourceGroupName (optional)
StringsharedSpaceName (optional)
StringspaceName (optional)
StringsvDeployTestDeploys and starts CA DevTest test or test suite provided as a .mar file.
Throws exception if .mar file is incorrect, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringmarFilePath
StringtestType
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvDeployVirtualServiceDeploys and starts virtual service provided as a .mar file to target VSE. More services could be provided using comma or newline separator.
Throws exception if .mar file is incorrect, virtual service is already deployed, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringmarFilesPaths
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvStartVirtualServiceStarts virtual service that is already deployed on target VSE. More services could be started using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvStopVirtualServiceStops virtual service that is running on target VSE. More services could be stopped using comma or newline separator.
Throws exception if virtual service is not running on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvUndeployVirtualServiceUndeploys (removes) virtual service from specified VSE. More services could be provided using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleanimportDeveloperProfileprofileId
StringdeveloperProfileId (optional)
StringimportIntoExistingKeychain (optional)
booleankeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
hudson.util.Secret
$class: 'DiawiUploader'token
StringfileName
StringproxyHost
StringproxyPort
intproxyProtocol
String$class: 'DistTestingBuilder'The goal of this plugin is to enable a distributed testing of some compiled classes on multiple nodes. Tests are send one by one to nodes in the label specified for the project and run. Test results are saved in the "results" directory in the project workspace. f.e. "TEST-helloword.HelloTest.xml" for the test class "helloworld.HelloTest".
This plugin suppose that all slaves in the specified label have a shared workspace directory. (like NFS)
Only classes in the "Tests classes directory" directory with a file name containing a "test" substring (case insensitive) are automatically found by this plugin and run.
If you enable "Publish JUnit test result report" in the "Post-build Actions" section and type "results/*.xml" you will see test results in the Hudson's web UI.
Only nodes in a label which were specified for this project ("Tie this project to a node") will be used for distributed testing. This label must contain at least 2 nodes.
It's possible let this plugin to compile tests class sources which were checkout from a repository if "Compile tests" checkbox was checked. Remember to provide all necessary libraries needed for compilation.
It's possible to check a "Wait for nodes which are busy" checkbox to wait for other nodes which are busy to be freed.
distLocations
distDir
StringlibLocations
libDir
StringtestDir
This specifies a relative path in the project workspace where compiled tests resides. For example if tests are in build/test/classes then type "build/test/classes". In case you check "Compile tests" checkbox this relative path will be used for storing compiled tests classes which were before check-out from a repository.
StringwaitForNodes
Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
booleancompileTests
If checked then all source codes in the "Tests classes directory" will be compiled. It's necessary to provide all libraries for compilation. Compiled tests will be saved into the directory "tests".
boolean$class: 'DockerBuilderControl'option
$class: 'DockerBuilderControlOptionProvisionAndStart'cloudName
StringtemplateId
String$class: 'DockerBuilderControlOptionRun'cloudName
Stringimage
StringpullCredentialsId
StringdnsString
Stringnetwork
StringdockerCommand
StringvolumesString
StringvolumesFrom
StringenvironmentsString
Stringhostname
StringmemoryLimit
intmemorySwap
intcpuShares
intshmSize
intbindPorts
StringbindAllPorts
booleanprivileged
booleantty
booleanmacAddress
String$class: 'DockerBuilderControlOptionStart'cloudName
StringcontainerId
String$class: 'DockerBuilderControlOptionStop'cloudName
StringcontainerId
Stringremove
boolean$class: 'DockerBuilderControlOptionStopAll'remove
boolean$class: 'DockerBuilderNewTemplate'dockerTemplate
dockerTemplateBase
$class: 'DockerTemplateBase'image
StringbindAllPorts (optional)
booleanbindPorts (optional)
StringcpuShares (optional)
intdevicesString (optional)
StringdnsString (optional)
StringdockerCommand (optional)
StringenvironmentsString (optional)
Zero or more environment variables that are set within the docker container. This is a multi-line text field. Each line must be of the form key=value and specify one variable name and its value.
Note that quotes are not interpreted.
e.g. foo="bar" will result in the quotes being part of foo's value.
Note also that whitespace is easily broken. Editing this field this without first expanding the box to its multi-line form will cause any whitespace within a line to be turned into end of line codes, breaking up the line and thus changing its meaning.
e.g. The single setting:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
can be (accidentally) turned into three separate settings:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
thus preventing the configuration from working as was intended.
StringextraHostsString (optional)
Stringhostname (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
intmemorySwap (optional)
intnetwork (optional)
Stringprivileged (optional)
booleanpullCredentialsId (optional)
StringshmSize (optional)
inttty (optional)
booleanvolumesFromString (optional)
StringvolumesString (optional)
Stringconnector
For all connection methods, Jenkins will start by triggering a docker run. Then, after this step, there will optionally be more steps to establish the connection. There is currently three alternative ways to connect your Jenkins master to the dynamically provisioned Docker agents.
There are different pros and cons for each connection method. Depending on your environment, choose the one matching your needs. More detailed prerequisites are provided once you select a given method.
docker exec, all by using the Docker API. The agent does not need to be able to reach the master through the network layers to communicate ; all will go through Docker API.
docker run command with the right secret. And the remoting agent will establish the connection with the master through the network. Hence, the agent must be able to access the master through its address and port.
attachuser (optional)
StringjnlpjnlpLauncher
tunnel
Stringvmargs
StringentryPointArgumentsString (optional)
StringjenkinsUrl (optional)
Stringuser (optional)
StringsshsshKeyStrategy
$class: 'InjectSSHKey'user
String$class: 'ManuallyConfiguredSSHKey'credentialsId
StringsshHostKeyVerificationStrategy
$class: 'KnownHostsFileKeyVerificationStrategy'Checks the known_hosts file (~/.ssh/known_hosts) for the user Jenkins is executing under, to see if an entry exists that matches the current connection.
This method does not make any updates to the Known Hosts file, instead using the file as a read-only source and expecting someone with suitable access to the appropriate user account on the Jenkins master to update the file as required, potentially using the ssh hostname command to initiate a connection and update the file appropriately.
$class: 'ManuallyProvidedKeyVerificationStrategy'Checks the key provided by the remote host matches the key set by the user who configured this connection.
key
The SSH key expected for this connection. This key should be in the form `algorithm value` where algorithm is one of ssh-rsa or ssh-dss, and value is the Base 64 encoded content of the key.
String$class: 'ManuallyTrustedKeyVerificationStrategy'Checks the remote key matches the key currently marked as trusted for this host.
Depending on configuration, the key will be automatically trusted for the first connection, or an authorised user will be asked to approve the key. An authorised user will be required to approve any new key that gets presented by the remote host.
requireInitialManualTrust
Require a user with Computer.CONFIGURE permission to authorise the key presented during the first connection to this host before the connection will be allowed to be established.
If this option is not enabled then the key presented on first connection for this host will be automatically trusted and allowed for all subsequent connections without any manual intervention.
boolean$class: 'NonVerifyingKeyVerificationStrategy'Does not perform any verification of the SSH key presented by the remote host, allowing all connections regardless of the key they present.
javaPath (optional)
StringjvmOptions (optional)
StringlaunchTimeoutSeconds (optional)
intmaxNumRetries (optional)
intport (optional)
intprefixStartSlaveCmd (optional)
StringretryWaitTime (optional)
intsuffixStartSlaveCmd (optional)
StringlabelString
StringinstanceCapStr
The maximum number of containers, based on this template, that this provider is allowed to run in total.
Note that containers which have not been created by Jenkins are not included in this total.
A negative value, or zero, or 2147483647 all mean "no limit" is imposed on the this template, although the overall cloud instance limit (if any) will still apply.
Deprecated you should configure template with memory/cpu constraints, so docker infrastructure can manage resource consumption.
Stringdisabled (optional)
disabledByChoice (optional)
booleanenabledByChoice (optional)
Note: If problems are encountered then this functionality may be disabled automatically. If that happens then it will be shown here. In this situation, the disabled state is transient and will automatically clear after the stated period has elapsed.
booleanmode (optional)
NORMAL, EXCLUSIVEname (optional)
If blank or just whitespace, a default of "docker" will be used.
StringnodeProperties (optional)
hudson.slaves.NodeProperty>
pullStrategy (optional)
PULL_ALWAYS, PULL_LATEST, PULL_NEVERpullTimeout (optional)
Note: This overrides the read timeout specified for the cloud, but only for the docker pull operation (as this operation is expected to take longer than most docker operations).
intremoteFs (optional)
StringremoveVolumes (optional)
booleanretentionStrategy (optional)
Specify the strategy when docker containers shall be started and stopped:
idleMinutes
int$class: 'DockerBuilderPublisher'dockerFileDirectory
StringfromRegistry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringcloud
StringtagsString
StringpushOnSuccess
booleanpushCredentialsId
StringcleanImages
booleancleanupWithJenkinsJobDelete
boolean$class: 'DockerComposeBuilder'useCustomDockerComposeFile
booleandockerComposeFile
Stringoption
$class: 'ExecuteCommandInsideContainer'privilegedMode
booleanservice
Stringcommand
Stringindex
intworkDir
String$class: 'StartAllServices'$class: 'StartService'service
Stringscale
int$class: 'StopAllServices'$class: 'StopService'service
String$class: 'DockerPullImageBuilder'registry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringimage
StringdockerShellconnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intcontainerLifecycle (optional)
createContainer (optional)
bindAllPorts (optional)
booleanbindPorts (optional)
Stringcommand (optional)
StringcpuShares (optional)
intcpusetCpus (optional)
StringcpusetMems (optional)
StringdevicesString (optional)
StringdnsString (optional)
StringdockerLabelsString (optional)
Stringentrypoint (optional)
StringenvironmentString (optional)
StringextraHostsString (optional)
Stringhostname (optional)
StringlinksString (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
longnetworkMode (optional)
Stringprivileged (optional)
booleanrestartPolicy (optional)
policyName
NO, UNLESS_STOPPED, ALWAYS, ON_FAILUREmaximumRetryCount
intshmSize (optional)
longtty (optional)
booleanuser (optional)
StringvolumesFromString (optional)
StringvolumesString (optional)
Stringworkdir (optional)
Stringimage (optional)
StringpullImage (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intcredentialsId (optional)
StringpullStrategy (optional)
PULL_ALWAYS, PULL_ONCE, PULL_LATEST, PULL_NEVERregistriesCreds (optional)
registryAddr
StringcredentialsId
StringremoveContainer (optional)
force (optional)
booleanremoveVolumes (optional)
booleanstopContainer (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
inttimeout (optional)
intexecutorScript (optional)
StringlongConnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intshellScript (optional)
String$class: 'DoktorStep'server
StringmarkdownIncludePatterns
value
StringmarkdownExcludePatterns
value
StringasciidocIncludePatterns
value
StringasciidocExcludePatterns
value
String$class: 'DotNetCoreRunner'targetCode
//Simple Example
public class JenkinsPlugin
{
public static void ScriptMain()
{
Console.WriteLine("Hello World from c#!!!");
}
}
// Complete example
using DotNetTools.Jenkins;
using System;
public class JenkinsPlugin
{
public static void ScriptMain(JenkinsManager manager)
{
Console.WriteLine("Hello World from c#!!!");
manager.SetSessionEnv("PI", Math.PI.ToString());
}
}
public void SetSessionEnv(string key, string value);
public string GetSessionEnv(string key);
StringadditionalPackages
StringdownloadProgetPackageDownload options are:
See Inedo documentation.
feedName
StringgroupName
StringpackageName
Stringversion
StringdownloadFormat
StringdownloadFolder
If a full pathname is not supplied then the downloaded package 'should' end up in the workspace, but this is not guaranteed. If you wish the package to be placed in the workspace the it is best to use the Jenkins variable ${WORKSPACE}
StringcrxDownloadpackageIds (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanlocalDirectory (optional)
Stringrebuild (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longgoogleStorageDownloadcredentialsId
StringbucketUri
This specifies the cloud object to download from Cloud Storage. You can view these by visiting the "Cloud Storage" section of the Cloud Console for your project.
A single asterisk can be specified in the object path (not the bucket name), past the last "/". The asterisk behaves consistently with gsutil. For example, gs://my-bucket-name/pre/a_*.txt would match the objects in cloud bucket my-bucket-name that are named pre/a_2.txt or pre/a_abc23-4.txt, but not pre/a_2/log.txt.
StringlocalDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
StringpathPrefix (optional)
The specified prefix will be stripped from all downloaded filenames. Filenames that do not start with this prefix will not be modified. If this prefix does not have a trailing slash, it will be added automatically.
String$class: 'DoxygenBuilder'doxyfilePath
StringinstallationName
StringcontinueOnBuildFailure
booleanunstableIfWarnings
boolean$class: 'DrMemoryBuilder'executable
Stringarguments
StringlogPath
StringtreatFailed
boolean$class: 'DrupalInstanceBuilder'db
Stringroot
Stringprofile
Stringrefresh
If checked, every build will wipe out and recreate a fresh Drupal instance.
Note that creating a fresh Drupal instance sends an email to the site administrator (by default admin@example.net) which may be annoying.
booleanupdb
boolean$class: 'DrupalReviewBuilder'Review code using the Coder Review module.
If your code base does not include Coder, then Coder will be downloaded automatically.
style
booleancomment
booleansql
booleansecurity
booleani18n
booleanroot
Stringlogs
Stringexcept
Specify modules/themes that should not be reviewed, relative to the Drupal root directory.
For instance if you want to review only custom code then you might want to exclude contributed and core projects:
sites/all/modules/contrib/**,
sites/all/themes/contrib/**,
modules/**,
themes/**,
profiles/**
This field supports FileSet includes.
StringignoresPass
If checked, warnings flagged as ignored will pass.
Note that the ignore system was introduced in Coder 7.x-2.4. This option will be ignored if using an older version of Coder.
boolean$class: 'DrupalTestsBuilder'uri
Stringroot
Stringlogs
StringexceptGroups
Actions, Aggregator, AJAX, Batch API, Block, Blog, Book, Bootstrap, Cache, Color, Comment, Contact, Contextual, Dashboard, Database, DBLog, Entity API, Field API, Field types, Field UI, File, File API, File API (remote), Filter, Form API, Forum, Help, Image, Locale, Mail, Menu, Module, Node, OpenID, Pager, Path, Path API, PHP, Poll, Profile, RDF, Search, Session, Shortcut, SimpleTest, Statistics, Syslog, System, Taxonomy, Theme, Tracker, Translation, Trigger, Update, Update API, Upgrade path, User, XML-RPCMultiple groups can be separated by a comma.
StringexceptClasses
Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.
Multiple classes can be separated by a comma.
String$class: 'ECXCDMBuilder'name
Stringpassword
Stringurl
Stringjob
Stringproduction
booleanmaxWaitTime
int$class: 'EclipseBuckminsterBuilder'installationName
Stringcommands
StringlogLevel
Stringparams
StringtargetPlatformName
StringuserTemp
StringuserOutput
StringuserCommand
StringuserWorkspace
StringglobalPropertiesFile
StringequinoxLauncherArgs
StringazureIoTEdgeBuildazureCredentialsId (optional)
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringresourceGroup (optional)
StringrootPath (optional)
StringazureIoTEdgeDeployazureCredentialsId (optional)
StringresourceGroup (optional)
StringrootPath (optional)
In some cases, the Edge solution is not under the root of the code repository. You can specify path to the root of Edge solution in build definition. Example: If your code repository is an Edge solution, then leave it to default value './'. If your solution is under subfolder 'edge', then set it to 'edge'" Please notice that the module.json file path is relative to the root path of solution.
StringdeploymentFilePath (optional)
StringdeploymentId (optional)
Input the IoT Edge Deployment ID, if ID exists, it will be overridden.Lowercase letters, numbers and the following characters are allowed [ -:+%_#*?!(),=@;' ], no more than 128 characters. For more information: Visit docs
StringdeploymentType (optional)
StringdeviceId (optional)
StringiothubName (optional)
Stringpriority (optional)
Set the priority to a positive integer to resolve deployment conflicts: when targeted by multiple deployments a device will use the one with highest priority or (in case of two deployments with the same priority) latest creation time. For more information: Visit docs
StringtargetCondition (optional)
A target condition to determine which devices will be targeted with this deployment. Example tags.environment='test', properties.reported.devicemodel='4000x'
StringazureIoTEdgeGenConfigazureCredentialsId (optional)
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentFilePath (optional)
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringresourceGroup (optional)
StringrootPath (optional)
StringazureIoTEdgePushazureCredentialsId (optional)
StringresourceGroup (optional)
StringacrName (optional)
StringbypassModules (optional)
List of modules to bypass when building.
You can leave this field empty to build all modules
Or use comma delimited list of modules. Example "ModuleA,ModuleB"
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringdockerRegistryEndpoint (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdockerRegistryType (optional)
StringrootPath (optional)
String$class: 'ElasticsearchQueryBuilder'query
StringaboveOrBelow
Stringthreshold
longsince
longunits
String$class: 'EnvInjectBuilder'propertiesFilePath
StringpropertiesContent
String$class: 'EnvPropagatorBuilder'envVariableString
String$class: 'EnvironmentManagerBuilder'systemId
intenvironmentId
intinstanceId
intcopyToServer
booleannewEnvironmentName
StringserverType
StringserverId
intserverHost
StringserverName
StringcopyDataRepo
booleanrepoType
StringrepoHost
StringrepoPort
intrepoUsername
StringrepoPassword
StringabortOnFailure
boolean$class: 'EnvironmentTagBuilder'credentials
Stringregion
String$class: 'EstimateBuilder'name
Stringtoken
StringarchiveFilePath
StringregWhichIncludedModules
StringreportConfigName
Stringuri
Stringsaasuri
Stringlanguage
StringregexExclude
StringtestOnly
booleanmaxNumberOfViolations
longfailBlockTotalVio
booleanmaxNumberOfBlockerViolations
longfailBlockBlockerVio
booleanmaxNumberOfImportantViolations
longfailBlockImportantVio
booleanmaxNumberOfOptimizationViolations
longfailBlockOptimizationVio
booleanmaxNumberOfWarningViolations
longfailBlockWarningVio
booleanexamTest_ExecutionFileexamName
StringpythonName
StringexamReport
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringpathExecutionFile (optional)
StringpathPCode (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleanexamTest_ModelexamName
StringpythonName
StringexamReport
StringexecutionFile (optional)
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanexamModel (optional)
StringjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringmodelConfiguration (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
boolean$class: 'ExeBuilder'exeName
StringcmdLineArgs
StringfailBuild
booleanexecuteCerberusCampaigncampaignName
Stringenvironment
Stringbrowser
Stringscreenshot
Stringverbose
StringpageSource
StringseleniumLog
StringtimeOut
Stringretries
Stringpriority
Stringtag
Stringss_p
StringssIp
Stringrobot
StringmanualHost
StringmanualContextRoot
Stringcountry
StringcerberusUrl
StringtimeOutForCampaignExecution
intjobDsladditionalClasspath (optional)
StringadditionalParameters (optional)
java.lang.Object>
failOnMissingPlugin (optional)
booleanfailOnSeedCollision (optional)
booleanignoreExisting (optional)
booleanignoreMissingFiles (optional)
booleanlookupStrategy (optional)
JENKINS_ROOT, SEED_JOBremovedConfigFilesAction (optional)
IGNORE, DELETEremovedJobAction (optional)
IGNORE, DISABLE, DELETEremovedViewAction (optional)
IGNORE, DELETEsandbox (optional)
booleanscriptText (optional)
Stringtargets (optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
StringunstableOnDeprecation (optional)
booleanuseScriptText (optional)
boolean$class: 'ExecuteJobBuilder'jobId
longjobName
StringjobType
StringabortOnFailure
booleanpublish
booleanprojectId
longbuildId
StringsessionTag
StringappendEnv
boolean$class: 'ExecuteKatalonStudioTask'version
Stringlocation
StringexecuteArgs
Stringx11Display
StringxvfbConfiguration
StringexecManrequestType (optional)
StringaltEMConfig (optional)
url
Stringcredentials
Stringbookmark (optional)
name
Stringfolder (optional)
StringexecParams (optional)
list (optional)
key
Stringvalue
StringpostExecute (optional)
action
Stringparams
StringprocessList (optional)
database
Stringproject
Stringprocesses
processPath
Stringfolder
StringrequestName
Stringrequest (optional)
name
StringwaitConfig (optional)
pollInterval
StringmaxRunTime
String$class: 'ExecutorBuildStep'frameworkType
StringrunningType
Stringapp
StringtestApplication
StringdeviceQueries
Other field that can be used:
StringrunTags
StringexecutorOptions
maxDevices
Accepted value: [1..1000]. Default is 10
Set the maximum number of devices to allocate for this step execution.
Only applicable for Fast feedback mode.
intminDevices
Accepted value: [1..1000]. Default is 10
Set the minimum number of devices to allocate for this step execution.
Only applicable for Fast feedback mode.
intignoreTestsFile
StringoverallExecTimeout
intcreationTimeout
intexportIpaappURL (optional)
StringarchiveDir (optional)
Specify the location of the path (usually BUILD_DIR specified by xcodebuild) to read the Archive for exporting the IPA file.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringassetPackManifestURL (optional)
StringcompileBitcode (optional)
booleancopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
StringmanualSigning (optional)
booleanpackResourcesAsset (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresourcesAssetURL (optional)
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanxcodeName (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringexportPackagesexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExportParametersBuilder'filePath
StringfileFormat
StringkeyPattern
StringuseRegexp
booleanexportProjectsexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExporterBuilder'$class: 'ExtensiveTestingBuilder'testPath
Stringlogin
Stringpassword
StringserverUrl
StringprojectName
Stringdebug
booleandownloadFeatureFilesserverAddress
StringprojectKey
StringtargetPath
String$class: 'FigletBuilder'message
StringfileOperationsfileOperations
fileCopyOperationincludes
Stringexcludes
StringtargetLocation
StringflattenFiles
booleanfileCreateOperationfileName
StringfileContent
StringfileDeleteOperationincludes
Stringexcludes
StringfileDownloadOperationurl
StringuserName
Stringpassword
StringtargetLocation
StringtargetFileName
StringfileJoinOperationsourceFile
StringtargetFile
StringfilePropertiesToJsonOperationsourceFile
StringtargetFile
StringfileRenameOperationsource
Stringdestination
StringfileTransformOperationincludes
Stringexcludes
StringfileUnTarOperationfilePath
StringtargetLocation
StringisGZIP
booleanfileUnZipOperationfilePath
StringtargetLocation
StringfileZipOperationfolderPath
StringfolderCopyOperationsourceFolderPath
StringdestinationFolderPath
StringfolderCreateOperationfolderPath
StringfolderDeleteOperationfolderPath
StringfolderRenameOperationsource
Stringdestination
String$class: 'FireLineBuilder'fireLineTarget
csp
If you select "Yes", this plugin will set the following content of CSP to allow access to HTML with JS or CSS.
sandbox allow-scripts; default-src *; style-src * http://* 'unsafe-inline' 'unsafe-eval'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'
Warning:
There is a security risk if you select "Yes".
booleanblockBuild
If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
booleanconfiguration
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<fireline>
<args>
<!-- 序号对应的规则种类,用加号+相连
1:代码规范类
2:内存类
3:日志类
4:安全类
5:空指针
6:多线程
-->
<scanTypes>1+2+4+5+6</scanTypes>
<!--以上写法过滤了日志类的所有规则-->
<!--以下为过滤掉指定的单条规则,请加QQ群298228528获取规则名称-->
<filterRules>
<!--<filterRule ruleName="LogOnOffRule" />
<filterRule ruleName="LogBlockRule" />
<filterRule ruleName="LogAssignmentRule" />-->
</filterRules>
<!--过滤掉你不想检查的文件(注意:重复代码检查不支持过滤)-->
<filterFiles>
<!--过滤单个文件-->
<!--<filterFile Name="R.java"/>-->
<!--过滤整个文件夹-->
<!--<filterFile Name="/facebook/"/>-->
</filterFiles>
</args>
</fireline>
以上配置文件去掉了日志类的规则,所以火线扫描过程中就不会执行日志类规则的检查。
StringreportPath
StringreportFileName
StringbuildWithParameter
可通过配置使用build with parameter插件,在项目构建时灵活使用火线扫描。
例如:在项目配置中设置参数化构建参数。配置boolean类型参数fireline。
则在此输入框中填写${fireline}即可
Stringjdk
JDK to be used for this FireLine analysis.
Tips:
JDK1.7 or 1.8 is compatible with FireLine.
Stringjvm
合理设置JVM参数可以有效提高扫描效率,建议JVM最低配置如下:
"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
String$class: 'FitnesseBuilder'options
java.lang.String>
$class: 'FixResultBuilder'defaultResultName
Stringsuccess
Stringunstable
Stringfailure
Stringaborted
StringflywayrunnerinstallationName
StringflywayCommand
Stringurl
Stringlocations
StringcommandLineArgs
StringcredentialsId
String$class: 'FogbugzLinkBuilder'fortifyCloudScanbuildId
StringuseAutoHeap
booleanxmx
StringrmiWorkerMaxHeap
StringbuildLabel
StringbuildProject
StringbuildVersion
StringuseSsc
booleansscToken
StringupToken
StringversionId
StringscanArgs
Stringfilter
StringnoDefaultRules
booleandisableSourceRendering
booleandisableSnippets
booleanquick
booleanrules
StringuseParallelAnalysis
booleanfrugalTestinguserId
StringtestId
StringrunTag
StringgetJtl
booleanserverUrl (optional)
String$class: 'FtpRenameBuilder'ftpServer
StringftpPort
if you don't specify the port, the default port is 21.
intftpUser
StringftpPassword
hudson.util.Secret
ftpPath
Specify the path to your artifact.
StringartifactName (optional)
StringnewArtifactName (optional)
StringremoteDirectory (optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
String$class: 'FxCopBuilder'toolName
Stringfiles
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ file/directory ]
StringoutputXML
FxCop project or XML report output file.
Command Line Argument: /out:[ output file path ]
StringruleSet
Rule set to be used for the analysis.
Command Line Argument: /ruleset:=[ Rule set file path ]
StringignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleanforceOutput
Write output XML and project files even in the case where no violations occurred.
Command Line Argument: /forceoutput
booleancmdLineArgs
StringfailBuild
boolean$class: 'GCloudSDKBuilder'command
String$class: 'GCloudSDKWithAuthBuilder'credentialsId
Stringcommand
String$class: 'GatekeeperCommit'commitUsername
String$class: 'GatekeeperMerge'commitUsername
StringreleaseFilePath
StringreleaseFileContentTemplate
String$class: 'GatekeeperPush'genexusbgxInstallationId
StringkbPath
StringkbVersion
StringkbEnvironment
StringforceRebuild
boolean$class: 'GenerateChangeScriptBuilder'in
Specify path to input folder for generating SQL change script. This folder should contain result of previously executed "Run Compare" build step.
Folder location must be specified as:
Stringout
Path to the file that should be used to store SQL change script.
File location must be specified as:
String$class: 'GenerateCreateScriptBuilder'outputFile
Path to the file that should be used to store create SQL script.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'GenerateJenkinsReportBuilder'Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.
Warning: You can include only one Generate Jenkins HTML comparison report step per project.
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String$class: 'GenerateStandaloneReportBuilder'inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
StringoutputFolder
Specify path to folder where standalone report will be exported.
Folder location must be specified as:
StringgitAutomergerreleaseBranchPattern
StringmergeRules
path
Stringresolution
KEEP_OLDER, KEEP_NEWER, MERGE_OLDER_TOP, MERGE_NEWER_TOPlogLevel
TRACE, DEBUG, INFO, WARN, ERRORremoteName
StringcheckoutFromRemote
booleangitbisectjobToRun
StringgoodStartCommit
StringbadEndCommit
StringsearchIdentifier
StringrevisionParameterName
StringretryCount
intcontinuesBuild
booleanminSuccessfulIterations
intoverrideGitCommand
booleangitCommand
StringgitHubPRStatusstatusMessage
content
String$class: 'GitHubSetCommitStatusBuilder'contextSource (optional)
$class: 'DefaultCommitContextSource'$class: 'ManuallyEnteredCommitContextSource'context
StringstatusMessage (optional)
content
String$class: 'GitStatusWrapperBuilder'The gitStatusWrapper builder wraps set of job builders and handles PENDING/SUCCESS/FAILURE git statuses automatically
Check documentation here
buildSteps
$class: 'GnatmakeBuilder'gnatName
Stringswitches
StringfileNames
StringmodeSwitches
StringgprbuildinstallationName (optional)
Stringnames (optional)
Stringproj (optional)
-P switch. If not specified, GPRbuild uses the project file
default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
Stringswitches (optional)
StringgradlebuildFile (optional)
StringgradleName (optional)
StringmakeExecutable (optional)
booleanpassAllAsProjectProperties (optional)
booleanpassAllAsSystemProperties (optional)
booleanprojectProperties (optional)
StringrootBuildScriptDir (optional)
Stringswitches (optional)
StringsystemProperties (optional)
Stringtasks (optional)
StringuseWorkspaceAsHome (optional)
Gradle will write to $HOME/.gradle by default for GRADLE_USER_HOME. For a multi-executor slave in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
booleanuseWrapper (optional)
booleanwrapperLocation (optional)
String$class: 'Groovy'Executes a groovy script.
scriptSource
$class: 'FileScriptSource'scriptFile
String$class: 'StringScriptSource'command
StringgroovyName
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
Stringparameters
Parameters for the Groovy executable.
StringscriptParameters
These parameters will be passed to the script.
Stringproperties
Instead of passing properties using the -D parameter you can define them here.
StringjavaOpts
Direct access to JAVA_OPTS. Properties allows only -D properties, while sometimes also other properties like -XX need to be setup. It can be done here. This line is appended at the end of JAVA_OPTS string.
StringclassPath
Specify script classpath here. Each line is one class path item.
String$class: 'GroovyRemoteBuilder'remoteName
Stringscript
String$class: 'GsshCommandBuilder'disable
booleanserverInfo
Stringshell
String$class: 'GsshFtpDownloadBuilder'disable
booleanserverInfo
StringremoteFile
StringlocalFolder
StringfileName
String$class: 'GsshFtpUploadBuilder'disable
booleanserverInfo
StringlocalFilePath
StringremoteLocation
StringfileName
String$class: 'GsshShellBuilder'disable
booleanserverInfo
Stringshell
String$class: 'HOTPlayer'project
Stringbundle
com.arkea.jenkins.openstack.heat.orchestration.template.Bundle
habitattask (optional)
Stringdirectory (optional)
Stringartifact (optional)
Stringchannel (optional)
Stringorigin (optional)
StringbldrUrl (optional)
StringauthToken (optional)
StringlastBuildFile (optional)
Stringformat (optional)
StringsearchString (optional)
Stringcommand (optional)
Stringbinary (optional)
Stringpath (optional)
Stringdocker (optional)
booleanhealthAnalyzerproducts
$class: 'HealthAnalyzerLrStep'checkLrInstallation
booleancheckOsVersion
booleancheckFiles
filesList
field
String$class: 'HttpRequest'url
StringacceptType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMauthentication (optional)
StringconsoleLogResponseBody (optional)
booleancontentType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMcustomHeaders (optional)
name
Stringvalue
StringmaskValue
booleanhttpMode (optional)
GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCHhttpProxy (optional)
StringignoreSslErrors (optional)
booleanmultipartName (optional)
StringoutputFile (optional)
StringpassBuildParameters (optional)
booleanquiet (optional)
booleanrequestBody (optional)
Stringtimeout (optional)
intuploadFile (optional)
StringuseSystemProperties (optional)
booleanvalidResponseCodes (optional)
StringvalidResponseContent (optional)
StringhugobaseUrl (optional)
StringbuildFuture (optional)
booleandestination (optional)
Stringenvironment (optional)
StringhugoHome (optional)
Stringverbose (optional)
boolean$class: 'HyperBuilder'image
Stringcommands
String$class: 'ITest'workspace
Required.
(1) Provide the full path to the iTest workspace containing projects, or
(2) Leave blank to indicate that the current job's workspace is also an iTest workspace (must contain an .iTestWorkspace file as created by iTest)
Stringprojects
Required. Specify the name of the iTest project to export in an ITAR file (required to use iTestRT). Separate names of multiple projects with comma.
Note: The project must exist within the specified iTest workspace.
Stringtestcases
Required. Specify path to test case or test suite to run: must include extension (path/name.fftc or path/name.ffts). Separate multiple with a comma.
Accepted Formats:
project://projectname/path/to/testcase
/full/path/to/testcase
Examples:
project://system_test/regression_test.fftc
${WORKSPACE}/system_test/regression_test.fftc
Stringtestbed
Specify the URI of the testbed or topology to use for execution. Must include file extension. Overrides the testbed specified in the test case file.
Accepted Formats:
/path/to/topology.tbml
Examples:
${WORKSPACE}/system_test/topologies/demo.tbml
Stringparams
Specify a parameter value in the format parameter=value. Separate multiple parameter/value pairs with a comma.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument takes precedence over the values in the parameter file.
StringparamFile
Specify URI of a parameter file in an iTest readable format.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument take precedence over the values in the parameter file.
StringtestReportRequired
Check this to generate test report in HTML format.
A link to the report will be provided on the project page, and the report will be available in the iTest workspace specified in the project configuration page.
booleandbCustomTag
This option enables you to define and assign a value to a custom tag.
Example: Create a tag that holds the build number so that you compare test execution results between builds.
For tests run against build 54322, use: --tag buildNumber=54322
Tip: Use a custom tag to identify executions or groups of executions on the iTest Team Server Test Execution page.
String$class: 'ImportFiles'url
StringcloudTestServerID
Stringfiles
Stringexcludes
Stringmode
StringadditionalOptions
StringimportPackagesimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
StringimportProjectsimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'InfluxDBPublisher'userCredentialsID
StringdbUrl
StringdbName
Stringcontent
StringinfluxDbQuerycheckName
StringinfluxQuery
StringexpectedThreshold
doublemarkUnstable (optional)
booleanretryCount (optional)
intretryInterval (optional)
intshowResults (optional)
booleaninsightAppSecregion
StringinsightCredentialsId
StringappId
StringscanConfigId
StringbuildAdvanceIndicator
StringvulnerabilityQuery
vulnerability.severity='HIGH'
StringmaxScanPendingDuration
0d 5h 30m
StringmaxScanExecutionDuration
0d 5h 30m
StringenableScanResults
boolean$class: 'InstallBuilder'apkFile
StringuninstallFirst
booleanfailOnInstallFailure
boolean$class: 'IqPolicyEvaluatorBuildStep'iqStage
StringiqApplication
manualApplicationapplicationId
StringselectedApplicationapplicationId
StringiqScanPatterns
**/target/*.war or
**/target/*.ear. If unspecified, the scan will default to the patterns
**/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
scanPattern
StringiqModuleExcludes
**/nexus-iq/module.xml) to be ignored, e.g.
**/my-module/target/**, **/another-module/target/**. If unspecified all modules will contribute dependency information (if any) to the scan.
moduleExclude
StringfailBuildOnNetworkError
booleanjobCredentialsId
- none -, otherwise select different credentials.
StringadvancedProperties
key1=value1
key2=value2
String$class: 'IspwRestApiRequest'connectionId (optional)
StringconsoleLogResponseBody (optional)
booleancredentialsId (optional)
StringispwAction (optional)
StringispwRequestBody (optional)
StringskipWaitingForSet (optional)
boolean$class: 'IssueFieldUpdateStep'issueSelector (optional)
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'fieldId (optional)
StringfieldValue (optional)
String$class: 'IssueUpdatesBuilder'restAPIUrl
StringuserName
Stringpassword
Stringjql
StringworkflowActionName
Stringcomment
StringcustomFieldId
StringcustomFieldValue
StringresettingFixedVersions
booleancreateNonExistingFixedVersions
booleanfixedVersions
StringfailIfJqlFails
booleanfailIfNoIssuesReturned
booleanfailIfNoJiraConnection
boolean$class: 'JBossBuilder'operation
value
START_AND_WAIT, START, SHUTDOWN, CHECK_DEPLOYproperties
StringstopOnFailure
booleanserverName
String$class: 'JIRATicketEditor'jiraCredentialsID
StringnewTicketsTemplates
performDuplicateCheck
booleanparentJQL
Stringtitle
Stringtype
Stringpriority
Stringdescription
StringenvVarName
StringfieldValues
fieldHumanReadableName
StringvalueToSet
StringmodifyTicketsTemplates
jqlFilter
StringcommitRegEx
StringticketSource
Stringmodifications
$class: 'AddCommentModification'commentBody
String$class: 'ModifyArrayFieldModification'fieldHumanReadableName
StringmodificationType
StringmodificationValue
String$class: 'PerformTransitionModification'transitionName
Stringcomment
String$class: 'SetFieldModification'fieldHumanReadableName
StringvalueToSet
String$class: 'JIRAVersionEditor'jiraCredentialsID
StringversionModifiactions
versionName
StringreplaceDescription
booleandescriptionText
StringreleaseState
StringfailOnJQL
booleanfailQuery
String$class: 'JSLintBuilder'includePattern
The files to include in an Ant-style filter. See javadoc
Example: lib/**/*.js
This would grab files including lib/foo.js and lib/foo/bar/baz.js
Example: lib/*.js
This would include lib/foo.js but not lib/foo/bar.js
StringexcludePattern
The files to exclude in an Ant-style filter. See javadoc
Example: lib/**/ModuleImportProgressDialog.js
This would omit any file named ModuleImportProgressDialog.js
Stringlogfile
The file to output to in a Checkstyle XML format
Example: target/jslint.xml
Stringarguments
The arguments to pass to JSLint. You can use any arguments that JSLint supports! Be sure, though, to prefix each argument with -D
Example: -Dadsafe=true, -Dcontinue=true
This would activate adsafe and continue
Example: -Dpredef=foo,bar,baz
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on.
Example: -Dpredef=foo,bar,baz, -Dmaxlen=80
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on. It also sets the maximum length of a line to 80 chars.
The default options we use are:
var defaultOptions = { bitwise: true, eqeqeq: false, immed: false, newcap: false, nomen: false, onevar: false, plusplus: false, regexp: false, rhino: true, undef: true, white: false, forin: true, sub: true, browser: true, laxbreak: true, predef: [ 'Ext', 'jQuery', 'window', '$', 'ActiveXObject', 'SWFObject' ] };
String$class: 'JabberBuilder'builderName
String$class: 'JbpmUrlResourceBuilder'url
StringprocessId
StringSoapUIPropathToTestrunner
StringpathToProjectFile
Stringenvironment (optional)
StringprojectPassword (optional)
StringtestCase (optional)
StringtestSuite (optional)
String$class: 'JigomergeBuilder'source
Stringusername
Stringpassword
StringoneByOne
booleaneager
booleanvalidationScript
StringdryRun
booleanverbose
booleanignoreMergePatterns
StringcommitCommentPrefix
String$class: 'JiraEnvironmentVariableBuilder'Typical usage:
issue in (${JIRA_ISSUES})
issueSelector
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'$class: 'JiraExtBuildStep'issueStrategy
$class: 'FirstWordOfCommitStrategy'$class: 'FirstWordOfUpstreamCommitStrategy'$class: 'MentionedInCommitStrategy'$class: 'SingleTicketStrategy'issueKey
Stringextensions
$class: 'AddComment'postCommentForEveryCommit
booleancommentText
String$class: 'AddFixVersion'fixVersion
The Fix Version to append. Must exist.
String$class: 'AddLabel'labelName
String$class: 'AddLabelToField'fieldName
StringfieldValue
String$class: 'Transition'transitionName
String$class: 'UpdateField'fieldName
StringfieldValue
String$class: 'JiraIssueUpdateBuilder'jqlSearch
Example:
or (e.g., combined with a JIRA Issue Parameter, selecting one issue from a JQL result set):project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
issue = $ISSUE_ID
StringworkflowActionName
Stringcomment
String$class: 'JiraReleaseVersionUpdaterBuilder'jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in JIRA.
(EXAMPLE-100)
StringjiraRelease
StringjiraDescription
String$class: 'JiraVersionCreatorBuilder'jiraVersion
StringjiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in JIRA.
(EXAMPLE-100)
String$class: 'JobConfigRebrander'$class: 'JobDeleteBuilder'target
String$class: 'JobStrongAuthSimpleBuilder'jobUsers
StringuseGlobalUsers
booleanjobMinAuthUserNum
intuseJobExpireTime
booleanjobExpireTimeInHours
int$class: 'JobcopyBuilder'fromJobName
StringtoJobName
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
booleanadditionalFilesetList
includeFile
StringexcludeFile
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
boolean$class: 'KanboardTaskFetcher'projectIdentifier
StringtaskReference
StringtaskAttachments (optional)
StringtaskLinks (optional)
String$class: 'KarafBuildStepBuilder'useCustomKaraf
booleankarafHome
Stringflags
specify the port to connect to
-h [host]specify the host to connect to
-u [user]specify the user name
-p [password]specify the password (optional, if not provided, the password is prompted)
-vraise verbosity
-lset client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]retry connection establishment (up to attempts times)
-d [delay]intra-retry delay (defaults to 2 seconds)
-f [file]read commands from the specified file
-k [keyFile]specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]define the client idle timeout
Stringoption
$class: 'KarafCommandFileOption'file
String$class: 'KarafCommandScriptOption'script (optional)
StringunlockMacOSKeychainkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
hudson.util.Secret
$class: 'KloBuilder'kwinspectreportDeprecated
booleandeleteTable
booleanprojectName
StringbuildName
StringkloName
StringbuildUsing
StringkwCommand
If you have selected to build using a build command, enter the command that generates the file kwinject.out (the file that contains information used by Klocwork to build the report).
For Java project, you can use kwant command and for C/C++ project, you can use kwinject command.
For more information on those commands :
Quick start page
Kwant command and Building Java project with Klocwork
Kwinject command and Building C/C++ project with Klocwork
For C# projects, see the quick start and Kwcsprojparser command
Please do not use the --output option or the build will fail. If you need the output file, you can retrieve it in the workspace of your project. The file is called kwinject.out.
If you have selected to build using an existing build specification file, enter the full or relative path to that file.
StringkwbuildprojectOptions
StringcompilerBinaryBuild
booleankwBinaryBuild
booleanbuildLog
booleanparseLog
boolean$class: 'KlocworkBuildSpecBuilder'buildSpecConfig
buildCommand
Stringtool
Stringoutput
StringadditionalOpts
StringignoreErrors
boolean$class: 'KlocworkCiBuilder'ciConfig
buildSpec
StringprojectDir
StringcleanupProject
booleanreportFile
StringadditionalOpts
StringincrementalAnalysis
This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit like behaviour. The idea is that only changed files are analysed using the Klocwork kwciagent tool to replicate the analysis developers would perform using Visual Studio, Eclipse or the command line utility. To enable this the plugin takes a list of the changed files from the SCM, this enables the ability to analyse only the changed files when the workspace isn’t kept. Leave this unticked to analyse the whole project or if the workspace is kept then a standard incremental analysis.
The diff file list is the file to contain the changed source files that Klocwork should analyse. It is required that any analysed files should exist in the build specification generated by kwinject
IMPORTANT: It is required that any files to be analysed must also exist in the build specification specified
If using Git, please provide the previous commit that Git should perform a "diff" with. The change list between the current commit and the specified previous commit will then be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build.
If you are not using Git, or want to manually generate the change list using Git, then please select this option. You will need to generate the diff file list with a custom build-step (or similar). Future support for more SCM tools (such as SVN, perforce) may be added depending on demand. The format of the file should be a changed source file per line
Future support for more SCM tools (such as SVN, perforce) may be added depending on demand.
booleandiffAnalysisConfig
diffType
StringgitPreviousCommit
StringdiffFileList
StringciTool
String$class: 'KlocworkServerAnalysisBuilder'serverConfig
buildSpec
StringtablesDir
StringincrementalAnalysis
booleanignoreCompileErrors
booleanimportConfig
StringadditionalOpts
StringdisableKwdeploy
boolean$class: 'KlocworkServerLoadBuilder'serverConfig (optional)
tablesDir (optional)
StringbuildName (optional)
StringadditionalOpts (optional)
StringreportConfig (optional)
displayChart (optional)
booleanchartHeight (optional)
StringchartWidth (optional)
Stringquery (optional)
String$class: 'KlocworkXSyncBuilder'syncConfig
dryRun
booleanlastSync
StringprojectRegexp
StringstatusAnalyze
booleanstatusIgnore
booleanstatusNotAProblem
booleanstatusFix
booleanstatusFixInNextRelease
booleanstatusFixInLaterRelease
booleanstatusDefer
booleanstatusFilter
booleanadditionalOpts
String$class: 'KmapJenkinsBuilder'username
Stringpassword
StringkmapClient
Stringcategories
Stringteams
Stringusers
StringsendNotifications
booleanpublishOptional
teams
Stringusers
StringsendNotifications
booleanfilePath
StringappName
Stringbundle
Stringversion
Stringdescription
StringiconPath
String$class: 'KojiBuilder'kojiBuild
StringkojiTarget
StringkojiPackage
StringkojiOptions
StringkojiTask
StringkojiScratchBuild
booleankojiScmUrl
String$class: 'KubernetesDeploy'context
configs (optional)
The path patterns for the Kubernetes configurations you want to deploy, in the form of Ant glob syntax.
StringcredentialsType (optional)
Choose how to get the kubeconfig file to authenticate with the Kubernetes cluster management endpoint.
3 options are supported:
~/.kube/config file through an SSH connection to the master node.See also: Configure kubectl
StringdockerCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringenableConfigSubstitution (optional)
Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleankubeConfig (optional)
path (optional)
kubeconfig file path relative to the current Jenkins workspace.
StringkubeconfigId (optional)
StringsecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g.,
some-secret-$BUILD_NUMBER. The name should be in the pattern
[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See
Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
Stringssh (optional)
sshCredentialsId (optional)
StringsshServer (optional)
<host>[:<port>]) of the Kubernetes master node. If port is omitted, the default SSH port 22 will be used.
StringtextCredentials (optional)
certificateAuthorityData (optional)
clusters.cluster.certificate-authority-data value in the
kubeconfig file.
StringclientCertificateData (optional)
users.user.client-certificate-data value in the
kubeconfig file.
StringclientKeyData (optional)
users.user.client-key-data value in the
kubeconfig file.
StringserverUrl (optional)
clusters.cluster.server address in the
kubeconfig. Generally, it should start with
https://.
StringkubernetesEngineDeploycluster (optional)
StringclusterName (optional)
StringcredentialsId (optional)
Stringlocation (optional)
StringmanifestPattern (optional)
Stringnamespace (optional)
StringprojectId (optional)
StringverboseLogging (optional)
booleanverifyDeployments (optional)
booleanverifyServices (optional)
booleanverifyTimeoutInMinutes (optional)
intzone (optional)
Stringloadcompletetestproject (optional)
Stringtest (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleangeneratePDF (optional)
booleantimeout (optional)
StringuseTimeout (optional)
booleaneventSourceLambdalambdaEventSourceBuildStepVariables
awsRegion
StringfunctionName
StringeventSourceArn
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringfunctionAlias (optional)
StringuseInstanceCredentials (optional)
booleaninvokeLambdalambdaInvokeBuildStepVariables
awsRegion
StringfunctionName
Stringsynchronous
booleanawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringjsonParameters (optional)
envVarName
StringjsonPath (optional)
Stringpayload (optional)
StringuseInstanceCredentials (optional)
booleanpublishLambdalambdaPublishBuildStepVariables
awsRegion
StringfunctionARN
StringfunctionAlias
StringversionDescription
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringuseInstanceCredentials (optional)
booleandeployLambdalambdaUploadBuildStepVariables
awsRegion
StringfunctionName
StringupdateMode
Stringalias (optional)
StringartifactLocation (optional)
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringcreateAlias (optional)
booleandeadLetterQueueArn (optional)
Stringdescription (optional)
StringenableDeadLetterQueue (optional)
booleanenvironmentConfiguration (optional)
environment
key
Stringvalue
StringconfigureEnvironment (optional)
booleankmsArn (optional)
Stringhandler (optional)
StringmemorySize (optional)
Stringpublish (optional)
booleanrole (optional)
Stringruntime (optional)
StringsecurityGroups (optional)
Stringsubnets (optional)
Stringtimeout (optional)
StringuseInstanceCredentials (optional)
boolean$class: 'LeiningenBuilder'task
StringsubdirPath
String$class: 'LiterateBuilder'baseName
Stringenvironment
String$class: 'LoadImpactTestRunTask'apiTokenId
StringloadTestId
intcriteriaDelayValue
intcriteriaDelayUnit
StringcriteriaDelayQueueSize
intabortAtFailure
booleanthresholds
metric
Stringoperator
Stringvalue
intresult
StringpollInterval
intlogHttp
booleanlogJson
boolean$class: 'LoadNinjaBuilder'apiKey
StringscenarioId
Stringoeb
errorPassCriteria
Stringodb
durationPassCriteria
String$class: 'LoadPluginBuilder'url
Stringusername
Stringpassword
Stringfile
StringgreettestId
StringcredentialsId
String$class: 'LoadrunnerBuilder'path
StringtestPath
StringconnectQC
booleancredentials (optional)
Stringhost (optional)
StringqcDb (optional)
StringtestSetId (optional)
String$class: 'LoadtestBuilder'loadtestBuilderModel
environmentShortName
StringauthToken
StringpresetName
StringloadtestScenario
StringloadtestThresholdParameters
metricType
StringevaluationDirection
StringnumericValue
double$class: 'LoginBuilder'credentialsId
StringhubUrl
StringmablrestApiKey
StringenvironmentId
StringapplicationId
StringcontinueOnMablError (optional)
booleancontinueOnPlanFailure (optional)
booleandisableSslVerification (optional)
boolean$class: 'MailCommandBuilder'| POP3 mail server address | Set POP3 mail server's hostname or ip address. |
| POP3 mail server port | Set POP3 mail server's port. Default value is 110. |
| POP3 User Name | Set POP3 mail server's user account. |
| POP3 Password | Set POP3 mail server's password. |
address
Stringport
Stringusername
Stringpassword
String$class: 'MaintenanceMode'apiKey
StringappName
Stringmode
boolean$class: 'MakeAppTouchTestable'url
StringcloudTestServerID
StringinputType
StringprojectFile
Stringtarget
StringlaunchURL
StringbackupModifiedFiles
booleanadditionalOptions
StringjavaOptions
String$class: 'ManageInstance'cloud
Stringworkspace
Stringoperations
com.elasticbox.jenkins.builders.Operation
$class: 'MatlabBuilder'localMatlab (optional)
StringtestRunTypeList (optional)
$class: 'RunTestsAutomaticallyOption'taCoberturaChkBx (optional)
booleantaJunitChkBx (optional)
booleantatapChkBx (optional)
boolean$class: 'RunTestsWithCustomCommandOption'customMatlabCommand (optional)
Stringmaventargets
Stringname
Stringpom
Stringproperties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
StringjvmOptions
StringusePrivateRepository
booleansettings
settings.xml file contains elements used to define values which configure Maven execution in various ways, like the
pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml file per default may live:
$M2_HOME/conf/settings.xml${user.home}/.m2/settings.xml see also: settings.xml reference
standardfilePathpath
String$class: 'MvnSettingsProvider'settingsConfigId
StringglobalSettings
standard$class: 'FilePathGlobalSettingsProvider'path
String$class: 'MvnGlobalSettingsProvider'settingsConfigId
String$class: 'Maven3Builder'mavenName
StringrootPom
Stringgoals
StringmavenOpts
String$class: 'MavenDeploymentDownloader'projectName
StringfilePattern
.*)
StringpermaLink
StringtargetDir
StringstripVersion
booleanstripVersionPattern
StringfailIfNoArtifact
booleancleanTargetDir
booleanmavenSnapshotCheckcheck (optional)
boolean$class: 'MberDownloader'accessProfileName
Stringfiles
StringoverwriteExistingFiles
booleanuseTags
booleanshowProgress
booleanoptional
booleanattempts
int$class: 'MberUploader'accessProfileName
StringbuildArtifacts
StringartifactFolder
StringartifactTags
StringoverwriteExistingFiles
booleanlinkToLocalFiles
booleanshowProgress
booleanoptional
booleanattempts
int$class: 'MdtoolSolutionBuilder'installationName
StringsolutionPath
Stringtarget
value
Stringconfiguration
value
Stringproject
value
Stringruntime
value
String$class: 'MediaUploadBuilder'file2upload
Specify the path of the file relative to the workspace.
StringautoMedia
Type or select the repository item path.
A path without an extension would be considered a folder into which the file will be uploaded.
If you specify a path of a file, that would be the name of the uploaded file in the repository.
StringredmineMetricsReportsettings (optional)
url
StringapiKey
Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
StringprojectName
Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
StringcustomQueryId
intsprintSize
Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.
int$class: 'MicroDocsChecker'microDocsReportFile
StringmicroDocsProjectName
StringmicroDocsGroupName
StringmicroDocsEnvironments
StringmicroDocsSourceFolder
StringmicroDocsFailBuild
booleanmicroDocsPublish
booleanmicroDocsNotifyPullRequest
boolean$class: 'MobileStudioTestBuilder'mobileStudioRunnerPath
StringtestPath
StringmsgServer (optional)
StringdeviceId (optional)
StringprojectRoot (optional)
StringtestAsUnit (optional)
boolean$class: 'MockLoadBuilder'mock-artifact-*.txt. There will be a JUnit test report with the file name
mock-junit.xml. Approximately 5% of the time, the build will "fail" its tests and thus no artifacts will be generated.
averageDuration
long$class: 'ModelBuilder'pushGuardSettings
minBufferSize
StringhubUrls
String$class: 'MonitorRemoteJobBuilder'hostName
StringjobName
StringtimeBefore
StringuserName
Stringpassword
StringuseSSL
boolean$class: 'MonkeyBuilder'filename
StringpackageId
StringeventCount
intthrottleMs
intseed
Stringcategories
StringextraParameters
StringmoveComponentsnexusInstanceId
Stringdestination
Stringsearch (optional)
java.lang.String>
tagName (optional)
StringmsbuildmsBuildName
StringmsBuildFile
Give the .proj or .sln file from the module root (SCM root directory or workspace directory) that MSBuild will use to build.
You can use build variables through the syntax ${var}.
StringcmdLineArgs
This is a whitespace separated-list of command-line arguments you can specify. These can be the same as if you were to run MSBuild from the command line.
StringbuildVariablesAsProperties
If set to true, Jenkins build variables will be passed to MSBuild as /p:name=value pairs.
Beware : Sensitive build variables such as passwords will not be added.
booleancontinueOnBuildFailure
If set to true, Job will continue despite MSBuild build failure.
booleanunstableIfWarnings
If set to true and warnings on compilation, the build will be unstable.
booleandoNotUseChcpCommand
boolean$class: 'MsBuildSQRunnerBegin'additionalArguments (optional)
StringmsBuildScannerInstallationName (optional)
StringprojectKey (optional)
StringprojectName (optional)
StringprojectVersion (optional)
StringsonarInstallationName (optional)
String$class: 'MsBuildSQRunnerEnd'$class: 'MsTestBuilder'msTestName
StringtestFiles
Specify the path to your MSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line.
You can use either relative path to the workspace or full path. Spaces in the path are allowed.
You can use Ant-style filters. i.e - foo/*, foo/**/bar.dll, foo/*.dll
Command Line Argument: /testcontainer
Stringcategories
Optional field, if you do not enter all test will run. If entered specify the test categories to run. You can use logical operators like:
| Cateogry Filter | Result |
| Priority1 | Any test with category Priority1 |
| Priority1&SpeedTest | Test that have both Priority1 and SpeedTest categories |
| Priority1|SpeedTest | Tests that have either Priority1 or SpeedTest categories |
| Priority1&!SpeedTest | Test that have Priority1 category and also do not have SpeedTest category. |
Command Line Argument: /category
StringresultFile
Specify name of the result file to create. The result file will be delete before each run and will be created relative to the workspace directory.
Command Line Argument: /resultsfile
StringcmdLineArgs
StringcontinueOnFail
Specify if the build should fail if a test fail (unchecked) or continue even if a test failed (checked).
boolean$class: 'MultiJobBuilder'phaseName
StringphaseJobs
jobName
StringjobAlias
StringjobProperties
StringcurrParams
booleanconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggerred job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleankillPhaseOnJobResultCondition
FAILURE, NEVER, UNSTABLEdisableJob
booleanenableRetryStrategy
booleanparsingRulesPath
StringmaxRetries
intenableCondition
booleanabortAllJob
booleancondition
StringbuildOnlyIfSCMChanges
booleanapplyConditionOnlyIfNoSCMChanges
booleanaggregatedTestResults
booleancontinuationCondition
ALWAYS, SUCCESSFUL, COMPLETED, UNSTABLE, FAILUREexecutionType
PARALLEL, SEQUENTIALLY$class: 'MystBuilder'mystAction
Stringconfig
StringmystWorkspace
Stringproperties
StringmystInstallationName
String$class: 'NISConnection'viewUrl
Stringaddress
Stringport
intprozent
intapiKeyapiUrl (optional)
Stringgroup (optional)
StringbinaryName (optional)
Stringdescription (optional)
StringwaitForResults (optional)
booleanwaitMinutes (optional)
intbreakBuildOnScore (optional)
booleanscoreThreshold (optional)
intapiKey (optional)
StringuseBuildEndpoint (optional)
booleandebug (optional)
booleanpassword (optional)
StringproxyEnabled (optional)
booleanshowStatusMessages (optional)
booleanstopTestsForStatusMessage (optional)
Stringusername (optional)
String$class: 'NSiqBuilder'srcDir
StringfileFilter
String$class: 'NantBuilder'nantBuildFile
StringnantName
Stringtargets
Stringproperties
String$class: 'NeoBuildAction'executable
/opt/NeoLoad 6.5/bin/NeoLoadCmd,
C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe or
/Applications/NeoLoad 6.5/bin/NeoLoadCmd.
StringprojectType
StringreportType
StringlocalProjectFile
/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp,
C:\neoload_projects\JenkinsExample\JenkinsExample.nlp or
/Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp or
C:\neoload_projects\JenkinsExample\JenkinsExample.yaml.
StringsharedProjectName
MyProjectName.
StringscenarioName
StringhtmlReport
${WORKSPACE}/neoload-report/report.html.
StringxmlReport
${WORKSPACE}/neoload-report/report.xml.
StringpdfReport
${WORKSPACE}/neoload-report/report.pdf.
StringjunitReport
${WORKSPACE}/neoload-report/junit-sla-results.xml.
StringscanAllBuilds
booleandisplayTheGUI
booleantestResultName
$Date{hh:mm - dd MMM yyyy} is replaced by the current date by NeoLoad and the value
${BUILD_NUMBER} is replaced by the current build number by Jenkins.
$Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER}).
StringtestDescription
StringlicenseType
StringlicenseVUCount
StringlicenseVUSAPCount
StringlicenseDuration
StringcustomCommandLineOptions
StringpublishTestResults
booleansharedProjectServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
Stringlabel
StringlicenseServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
Stringlabel
StringcollabPath
StringlicenseID
StringshowTrendAverageResponse
booleanshowTrendErrorRate
booleangraphOptionsInfo
name
Stringcurve
path
Stringstatistic
StringmaxTrends
int$class: 'NerrvanaPlugin'settingsXmlString
Stringloglevel
Stringneuvectorrepository
StringregistrySelection
StringnameOfVulnerabilityToFailFour (optional)
StringnameOfVulnerabilityToFailOne (optional)
StringnameOfVulnerabilityToFailThree (optional)
StringnameOfVulnerabilityToFailTwo (optional)
StringnumberOfHighSeverityToFail (optional)
StringnumberOfMediumSeverityToFail (optional)
StringscanLayers (optional)
booleantag (optional)
String$class: 'NexusArtifactUploader'nexusVersion
Stringprotocol
StringnexusUrl
StringgroupId
Stringversion
Stringrepository
StringcredentialsId
Stringartifacts
artifactId
Stringtype
Stringclassifier
Stringfile
String$class: 'NexusPublisherBuildStep'nexusInstanceId
StringnexusRepositoryId
Stringpackages
$class: 'MavenPackage'mavenCoordinate
groupId
StringartifactId
Stringversion
Stringpackaging
StringmavenAssetList
filePath
Stringclassifier
Stringextension
StringtagName (optional)
Stringnirmatabuilder
Delete App in Environment
Deletes the specified application from the specified environment.
Deploy App in Environment
Deploys the specified application from catalog to specified application.
Update App in Catalog
Updates the specified application in specified catalog.
Update App in Environment
Updates the specified application in specified environment.
deleteAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdeployAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intcatalog
Stringdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringdeployType
StringupdateAppInCatalogendpoint
Stringapikey
Stringcatalog
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringupdateAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
Stringnodejscicommand
StringnodeJSInstallationName
StringcacheLocationStrategy (optional)
defaultexecutorworkspaceconfigId (optional)
String$class: 'NopmdCheckPublisher'filesetList
pattern
StringexcludePattern
String$class: 'NouvolaBuilder'planID
StringapiKey
StringcredsPass
StringwaitTime
StringreturnURL
StringlistenTimeOut
String$class: 'NvEmulationBuilder'serverName
StringincludeClientIPs
StringexcludeServerIPs
StringreportFiles
StringthresholdsFile
StringuseProxyCheckbox
envVariable
Stringsteps
$class: 'OOBuildStep'ooServer
Stringbasepath
Default path: /Library
E.g.:
Library/Tutorials/subflows/
Library/Templates
StringselectedFlow
Stringargs
name
Stringvalue
StringretVariableToCheck
StringcomparisonOrdinal
intvalueToCompareWith
StringdesiredResultType
StringstepExecutionTimeout
xxx ms. The plugin will wait for this amount of time, then it will finish the Jenkins job and it will automatically put the build in the fail/unstable state.
StringrunName
String$class: 'OctoperfBuilder'credentialsId
StringscenarioId
StringstopConditions (optional)
org.jenkinsci.plugins.octoperf.conditions.TestStopCondition
OneSkyprojectId (optional)
StringresourcesPath (optional)
String$class: 'OpenShiftBuildVerifier'apiURL
StringbldCfg
Stringnamespace
StringauthToken
Stringverbose
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftBuilder'apiURL
StringbldCfg
Stringnamespace
Stringenv
name
Stringvalue
StringauthToken
Stringverbose
StringcommitID
StringbuildName
StringshowBuildLogs
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftCreator'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterJsonYaml'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterLabels'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
Stringvalues
String$class: 'OpenShiftDeleterList'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
String$class: 'OpenShiftDeployer'apiURL
StringdepCfg
Stringnamespace
StringauthToken
Stringverbose
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftDeploymentVerifier'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftExec'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringpod
Stringcontainer
Stringcommand
Stringarguments
value
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftImageTagger'apiURL
StringtestTag
StringprodTag
Stringnamespace
StringauthToken
Stringverbose
StringtestStream
StringprodStream
StringdestinationNamespace
StringdestinationAuthToken
Stringalias
String$class: 'OpenShiftScaler'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftServiceVerifier'apiURL
StringsvcName
Stringnamespace
StringauthToken
Stringverbose
String$class: 'OrchestratorBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringworkflowName
StringwaitExec
booleaninputParams
name
Stringtype
Stringvalue
StringuTesterPageCountTaskinitialUrl
StringurlsWhiteList
StringpageCount
intrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
int$class: 'ParallelTestExecutor'This builder can be used with any test job that (1) produce JUnit-compatible XML files, and (2) accept a test-exclusion list in a file. This builder looks at the test execution time from the last time, and divide tests into multiple units of roughly equal size. Each unit is then converted into the exclusion list (by excluding all but the tests that assigned to that unit), and the test job is triggered for each unit, with the exclusion file placed inside the workspace at your specified location.
Optionally, if your test job supports it, you may provide a test-inclusion file name. If defined, the plugin will generate inclusion lists for all parallel units but one which will still use exclusion list. This avoids new test cases from being included in all units on their first run. If you don't use an inclusion file, when a new test is added, the first build afterward will be executed in all the sub-builds, because it's not in the exclusion list on any of the units.
You are responsible for configuring the build script in the test job to honor the exclusion and inclusion file. A standard technique is to write the build script to always refer to a fixed exclusion list file, and check in an empty file by that name to your SCM. You can then specify that file as the "exclusion file name" in the configuration of this builder, and the builder will overwrite the empty file from SCM by the generated one.
Similarly, you are responsible for checking "Execute concurrent builds if necessary" on the test job to allow the concurrent execution.
At the end of the executions of the test job, the specified report directories are brought back into this job's workspace, then the standard JUnit test report collector will tally them.
parallelism
countsize
inttimeThis value counts just the time spent on executing tests, and not including other time such as checking out the code, building the test, etc. For example, if your test job spends 50 minutes in tests and 60 minutes total from start to finish, then you have 10 minutes "fixed" overhead regardless of the number of tests it executes. If you use this mode and set the value to "10 minutes", then you'll have 5 parallel sub-tasks that all ends in roughly 20 minutes (20 mins = 10 mins tests time + 10 mins overhead.)
"N minutes per a sub-task" is a goal, not a hard constraint. So a sub-task can take longer (for example if you have a single test that takes more than N minutes.)
mins
inttestJob
StringpatternFile
StringtestReportFiles
The path is relative to the workspace of the test job. For Maven builds, this value is normally "**/target/surefire-reports/".
StringarchiveTestResults
booleanparameters
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggerred job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleanestimateTestsFromFiles
booleanincludesPatternFile (optional)
String$class: 'ParameterPoolBuilder'projects
Stringname
Stringvalues
StringpreferError
boolean$class: 'PartialReleaseMgrSuccessfulBuilder'pcBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestId
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringpcGitBuilddescription
StringpcServerName
StringhttpsProtocol
booleancredentialsId
StringalmDomain
StringalmProject
StringserverAndPort
StringproxyOutURL
StringcredentialsProxyId
StringsubjectTestPlan
StringuploadScriptMode
RUNTIME_FILES, ALL_FILESremoveScriptFromPC
YES, NOimportTests
Note:
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the Performance Center project). If not specified, a Controller will be chosen from the different controllers available in the Performance Center project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the Performance Center project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the Performance Center root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
Duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
YES, NOpcRunBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestToRun
StringtestId
StringtestContentToCreate
The content of the field must either be:
Note:
| Parameter | Description | Required |
|---|---|---|
| test_name | The test name. | Yes |
| test_folder_path | The location of the test in the Test Management folder tree of the Performance Center project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the Performance Center root folder (named "Subject") | Yes |
| test_content | The content of the test that requires additional parameters specified in the 'test_content' table below. | Yes |
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the Performance Center project). If not specified, a Controller will be chosen from the different controllers available in the Performance Center project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the Performance Center project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the Performance Center root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringactivateDTConfigurationdynatraceProfile
Stringconfiguration
StringcreateMemoryDumpdynatraceProfile
Stringagent
Stringhost
StringautoPostProcess (optional)
booleancapturePrimitives (optional)
booleancaptureStrings (optional)
booleandogc (optional)
booleanlockSession (optional)
booleantype (optional)
StringstartSessiondynatraceProfile
StringtestCase
StringlockSession (optional)
booleanrecordingOption (optional)
StringstopSessiondynatraceProfile
StringcreateThreadDumpdynatraceProfile
Stringagent
Stringhost
StringlockSession (optional)
booleanblazeMeterTestcredentialsId (optional)
StringworkspaceId (optional)
StringtestId (optional)
StringabortJob (optional)
booleanadditionalTestFiles (optional)
StringgetJtl (optional)
booleangetJunit (optional)
booleanjobApiKey (optional)
StringjtlPath (optional)
StringjunitPath (optional)
StringmainTestFile (optional)
Stringnotes (optional)
StringreportLinkName (optional)
StringserverUrl (optional)
StringsessionProperties (optional)
Stringbztparams
StringalwaysUseVirtualenv (optional)
booleanbztVersion (optional)
StringgeneratePerformanceTrend (optional)
booleanprintDebugOutput (optional)
booleanuseBztExitCode (optional)
booleanuseSystemSitePackages (optional)
booleanworkingDirectory (optional)
Stringworkspace (optional)
String$class: 'PhingBuilder'name
StringbuildFile
If your build requires a custom -buildfile, specify it here. By default Phing will use the build.xml in the module directory, this option can be used to use build files with a different name or in somewhere outside the top directory.
And you can use environment variables such like ''$WORKSPACE''.
Stringtargets
Stringproperties
# comment name1=value1 name2=value2These are passed to Phing like "-Dname1=value1 -Dname2=value2"
StringuseModuleRoot
booleanoptions
String$class: 'PipelineGenerationStep'project
Name of the project. It is used as an identifier in the corresponding pipelines, folders and jobs being generated.
StringprojectScmType
Type of the SCM. Currently only svn and git are supported.
StringprojectScmUrl
URL to the project SCM. Without any branch indication.
For example:
svn, URL to the root of the project, without trunk or branches. git, URL of the remote.StringprojectScmCredentials
ID or UUID of the Jenkins credentials to use when connecting to the project SCM.
Stringbranch
SCM branch.
StringseedProject
Project name useable for folders, job names, etc.
StringseedBranch
Branch name useable for folders, job names, etc.
StringdisableDslScript
If checked, the pipeline generation disallows the direct execution of a DSL Groovy script. Only DSL libraries, configured through a seed.properties file are allowed. By default, both modes are allowed.
booleanscriptDirectory
Path to the directory which contains the pipeline script. Defaults to seed if not filled.
String$class: 'PlayBuilder'playToolHome
StringprojectPath
StringplayVersion
$class: 'Play1x'commands
$class: 'PlayAutoTest'$class: 'PlayBuild'$class: 'PlayClean'$class: 'PlayCompile'$class: 'PlayCustom'parameter
String$class: 'PlayDist'$class: 'PlayInstall'$class: 'PlayJavadoc'$class: 'PlayPackage'$class: 'PlayPrecompile'$class: 'PlayPublish'$class: 'PlayTest'$class: 'PlayTestOnly'parameter
String$class: 'PlayWar'parameter
String$class: 'Play2x'commands
$class: 'PlayAutoTest'$class: 'PlayBuild'$class: 'PlayClean'$class: 'PlayCompile'$class: 'PlayCustom'parameter
String$class: 'PlayDist'$class: 'PlayInstall'$class: 'PlayJavadoc'$class: 'PlayPackage'$class: 'PlayPrecompile'$class: 'PlayPublish'$class: 'PlayTest'$class: 'PlayTestOnly'parameter
String$class: 'PlayWar'parameter
Stringplotgroup
Stringstyle
StringcsvFileName
StringcsvSeries (optional)
file
Stringurl
StringinclusionFlag
StringexclusionValues
StringdisplayTableFlag
booleanexclZero (optional)
booleankeepRecords (optional)
booleanlogarithmic (optional)
booleannumBuilds (optional)
StringpropertiesSeries (optional)
file
Stringlabel
Stringtitle (optional)
StringuseDescr (optional)
booleanxmlSeries (optional)
file
Stringxpath
StringnodeType
Stringurl
Stringyaxis (optional)
StringyaxisMaximum (optional)
StringyaxisMinimum (optional)
String$class: 'PowerShell'command
String$class: 'PowerShellBuildStep'buildStepId
StringscriptBuildStepArgs
defineArgs
booleanbuildStepArgs
arg
String$class: 'PrereqBuilder'projects
StringwarningOnly
booleanprobelyScantargetId
StringcredentialsId
String$class: 'ProjectGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
String$class: 'ProjectPrerequisitesInstaller'protecodesccredentialsId (optional)
StringprotecodeScGroup (optional)
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/ or with Groups API https://protecode-sc.mydomain.com/api/groups/.
StringconvertToSummary (optional)
protecodesc.xml.
booleancustomHeader (optional)
StringdirectoryToScan (optional)
StringdontZipFiles (optional)
booleanendAfterSendingFiles (optional)
booleanfailIfVulns (optional)
booleanincludeSubdirectories (optional)
booleanpattern (optional)
StringprotecodeScanName (optional)
StringscanOnlyArtifacts (optional)
booleanscanTimeout (optional)
int$class: 'ProxyBuilder'projectName
String$class: 'PublishBuilder'packageid
StringnugetFeedUrl
StringnugetFeedApiKey
StringpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'PublishStepBuilder'packageId
StringnugetFeedUrl
StringnugetFeedUrlApi
StringpackageVersion
String$class: 'PullRequestCommenter'comment
String$class: 'PushBuilder'remoteImageStrategy
DO_NOT_USE, GENERATE_GIT, FIXEDhubUrls
Stringorganization
StringoverwriteOrganization
booleanremoteImageName
StringdateFormat
| y|Y | Year |
| M | Month |
| w | Week in year |
| W | Week in month |
| D | Day in year |
| d | Day in month |
| F | Day of week in month |
| E | Day name in week |
| u | Day number of week (1 = Monday, ..., 7 = Sunday) |
| H | Hour in day (0-23) |
| k | Hour in day (1-24) |
| K | Hour in am/pm (0-11) |
| h | Hour in am/pm (1-12) |
StringappendDate
booleanincrementVersion
boolean$class: 'Python'Runs a Python script (defaults to python interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'PythonBuilder'pythonName
Stringnature
Stringcommand
StringignoreExitCode
booleanqualityCloudsScancredentialsId
StringinstanceUrl
StringissuesCountThreshold
inttechDebtThreshold
intqcThreshold
inthighSeverityThreshold
int$class: 'QFTestConfigBuilder'In this build step you can select which test-suites your job should run.
Note that the path for a test-suite or parent folder has to be relative to the workspace, which has to be specified above under "Advanced Project Options - Use custom workspace".
Examples:
-"Suites/MySuite/some_suite.qft" only runs one test-suite
-"Suites/MySuite" runs all test-suites in the MySuite folder
-"*" runs all test-suites in your workspace
Any of these command line arguments under the label "Test execution" can be used for the execution of your test-suites.
For the post-build actions to work, make sure to provide the correct paths to the logs and reports:
Archive the artifacts: qftestJenkinsReports/$JOB_NAME/$BUILD_NUMBER/logs/*.q*
Publish HTML reports: qftestJenkinsReports/$JOB_NAME/$BUILD_NUMBER/html/ and change index.html to report.html
Publish JUnit test result report: qftestJenkinsReports/$JOB_NAME/$BUILD_NUMBER/junit/report_junit.xml
For further information please see the QF-Test manual.
suitefield
net.sf.json.JSONObject
customPath
By activating this option you can specify a dedicated QF-Test version, different from the installed one.
For example "C:\Program Files (x86)\qfs\qftest\qftest-<VERSION>\"
net.sf.json.JSONObject
customReports
This plugin will create a folder for temporary files in your workspace.
The default directory is /YourWorkspace/qftestJenkinsReports/, but it can be changed here.
In case the name is changed, the paths of the post-build actions also have to be adapted accordingly.
net.sf.json.JSONObject
daemon
Details on how to use the daemon mode can be found in the QF-Test manual.
Note: The daemon has to be started seperately. The plugin will not start or terminate the daemon.
net.sf.json.JSONObject
$class: 'QualityCenter'qcClientInstallationName
StringqcQTPAddinInstallationName
StringqcServerURL
qcbin folder of the Quality Center Web application.
StringqcLogin
StringqcPass
StringqcDomain
StringqcProject
StringqcTSFolder
StringqcTSName
StringqcTSLogFile
Name of the report that will be generated.
If several test sets are run in one build step, one report will be generated per test set. As such, you must ensure that the name will be unique by including the test set name in it (through the ${TS_NAME} variable). If it's not the case, then the name will be automatically post fixed with an underscore followed by the test set name.
You can use all standard environment variables plus:
${QC_DOMAIN} for the current Quality Center domain;${QC_PROJECT} for the current Quality Center project;${TS_FOLDER} for the current TestSet folder;${TS_NAME} for the TestSet name.StringqcTimeOut
intrunMode
StringrunHost
StringacrQuickTaskazureCredentialsId
StringresourceGroupName
StringregistryName
Stringarchitecture (optional)
StringbuildArgs (optional)
docker build --build-arg.
key
Stringvalue
Stringsecrecy
booleandockerfile (optional)
StringgitPath (optional)
StringgitRefspec (optional)
StringgitRepo (optional)
https://PAT@github.com/user/repo.git for private repo.
StringimageNames (optional)
image
Stringlocal (optional)
StringnoCache (optional)
no-cache flag when build as
docker build --no-cache
booleanos (optional)
StringsourceType (optional)
Stringtarball (optional)
http://remoteserver/myapp.tar.gz
Stringtimeout (optional)
intvariant (optional)
String$class: 'R'Runs an R script (defaults to RScript interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'RAD'activateProjectWorkspaceVar
WORKSPACE environment variable through the
PROJECT_WORKSPACE one.
WORKSPACE variable during this build step as it doesn't refer to the workspace of the project: It is internally used by RAD.
booleanbuildFile
build.xml one in the project's workspace. The base directory is the
workspace.
StringdeleteRadWorkspaceContent
.metadata folder.
booleandeleteRadWorkspaceMetadata
.metadata folder of RAD's workspace has to be removed before RAD is actually run.
booleanproperties
# comment
name1=value1
name2=value2
These are passed to RAD like "-Dname1=value1 -Dname2=value2"
StringradInstallationName
StringradWorkspace
Stringtargets
String$class: 'RPDCreateInstance'pack
StringinstanceName
StringcustomProfile
String$class: 'RPDDeployInstance'instanceName
Stringpack
Stringenvironment
Stringroute
StringcustomProfile
StringuseCustomProfile
boolean$class: 'RTCGitBuilder'serverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringannotateChangeLog
Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
booleanbuildDefinition (optional)
The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
StringjenkinsRootURI (optional)
StringjenkinsRootURIOverride (optional)
Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
booleantimeout (optional)
The timeout period in seconds for Jazz repository requests made during the build.
inttrackBuildWorkItem (optional)
Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
StringuseBuildDefinition (optional)
booleanuseTrackBuildWorkItem (optional)
booleanuseWorkItems (optional)
booleanworkItemUpdateType (optional)
StringrabbitMQPublisherrabbitName
Stringexchange
Stringdata
Stringconversion (optional)
booleanroutingKey (optional)
StringtoJson (optional)
boolean$class: 'RadarGunBuilder'radarGunInstance
$class: 'RadarGunCustomInstallation'home
String$class: 'RadarGunInstallationWrapper'radarGunName
StringscenarioSource
$class: 'FileScenarioSource'scenarioPath
String$class: 'TextScenarioSource'scenario
StringnodeSource
$class: 'FileNodeConfigSource'nodeListPath
String$class: 'TextNodeConfigSource'nodes
StringscriptSource
$class: 'BuildInScriptSource'$class: 'FileScriptSource'masterPath
StringslavePath
String$class: 'TextScriptSource'masterScript
StringslaveScript
StringremoteLoginProgram
StringremoteLogin
StringworkspacePath
StringpluginPath
StringpluginConfigPath
StringreporterPath
String$class: 'Rake'rakeInstallation
StringrakeFile
Stringtasks
StringrakeLibDir
StringrakeWorkingDir
Stringsilent
booleanbundleExec
boolean$class: 'RallyBuild'preRallyState
stateName
StringissueString
StringupdateOnce
booleanpreComment
preCommentText
StringpreReady
preReadyState
booleanchangeReady
issueReady
booleancreateComment
commentText
StringchangeRallyState
issueRallyState
StringchangeDefectRallyState
defectRallyState
StringrancherenvironmentId
Stringendpoint
StringcredentialId
Stringservice
Stringimage
Stringconfirm
booleanstartFirst
booleanports
Stringenvironments
Stringtimeout
int$class: 'RanorexRunnerBuilder'rxTestSuiteFilePath
StringrxRunConfiguration
StringrxReportDirectory
StringrxReportFile
StringrxReportExtension
StringrxJUnitReport
booleanrxZippedReport
booleanrxZippedReportDirectory
StringrxZippedReportFile
StringrxGlobalParameter
StringcmdLineArgs
| Flag | Function |
|---|---|
| config | cfg:<config parameter name>=<value> | Set values for configuration parameters. |
| reportlevel | rl: Debug|Info|Warn|Error|Success|Failure|<any integer> | Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120 |
| testcase | tc:<name or guid of test case> | Runs this test case only. |
| testsuite | ts:<path to test suite file> | Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>. |
| module | mo:<module name or guid> | Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched. |
| testcaseparam | tcpa:<name or guid of test case>:<parameter name>=<value> | Creates or overrides values for testcase parameters specified in the test suite. |
| runlabel | rul:<custom value> | Sets a custom runlabel for the test run. |
| testcasedatarange | tcdr:<name or guid of test case>=<data range> | Sets the data range for a testcase. |
String$class: 'RapidDeployJobPlanRunner'serverUrl
StringauthenticationToken
StringjobPlan
StringasynchronousJob
booleanshowFullLogs
boolean$class: 'RapidDeployJobRunner'serverUrl
StringauthenticationToken
Stringproject
Stringtarget
StringpackageName
StringasynchronousJob
boolean$class: 'RapidDeployPackageBuilder'serverUrl
StringauthenticationToken
Stringproject
StringenableCustomPackageName
booleanpackageName
StringarchiveExtension
String$class: 'RebaseBuilder'You can rebase from the latest revision in the upstream branch, but you can also do safer rebase by choosing the permalink. For example, if you specify "last stable", then Jenkins will look for the last stable build, then rebase with the corresponding Subversion revision. Thus you know that you are rebasing to the known good state.
If you don't want Jenkins to automatically rebase, you can still use the "Rebase From Upstream" link from the left to manually initiate the rebase.
permalink
StringstopBuildIfMergeFails
booleansetUnstableIfMergeFails
boolean$class: 'RebootIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'ReconfigureBox'id
Stringcloud
Stringworkspace
Stringbox
Stringinstance
Stringvariables
StringbuildStep
StringbuildStepVariables
String$class: 'ReinstallBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringandroidApkMoveapkFilesPattern (optional)
StringapplicationId (optional)
StringfromVersionCode (optional)
booleangoogleCredentialsId (optional)
StringrolloutPercentage (optional)
StringtrackName (optional)
StringversionCodes (optional)
String$class: 'RemoteBuildConfiguration'abortTriggeredJob (optional)
booleanauth2 (optional)
CredentialsAuthcredentials (optional)
StringNoneAuthNullAuthTokenAuthapiToken (optional)
StringuserName (optional)
StringblockBuildUntilComplete (optional)
booleandisabled (optional)
booleanenhancedLogging (optional)
booleanjob (optional)
StringloadParamsFromFile (optional)
booleanmaxConn (optional)
intparameterFile (optional)
Stringparameters (optional)
StringpollInterval (optional)
intpreventRemoteBuildQueue (optional)
booleanremoteJenkinsName (optional)
StringremoteJenkinsUrl (optional)
StringshouldNotFailBuild (optional)
booleantoken (optional)
StringuseCrumbCache (optional)
booleanuseJobInfoCache (optional)
booleancrxReplicatepackageIds (optional)
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
long$class: 'Restart'apiKey
StringappName
StringpublishReview$class: 'ReviewboardApplyPatch'$class: 'ReviewboardPollingBuilder'reviewbotJobName
StringcheckBackPeriod
StringreviewbotRepoId
StringrestrictByUser
booleandisableAdvanceNotice
boolean$class: 'RigorBuilder'credentialsId
Please select a credential of Kind Rigor API Key here.
Note: Your Rigor Optimization API key can be found on the API Credentials settings page in the Rigor Optimization application. The API key must have User or higher level permissions.
StringperformanceTestIds
List 1 or more test IDs (as a comma separated list) of Rigor Optimization Performance Tests to be run during this step. You can locate the performance test ID by hovering over the Info (i) icon on any performance test in the View Results page of your Rigor Optimization account.
If Fail build based on results is checked below, this step will wait until all tests complete before proceeding. If unchecked, this step will launch these tests, but not wait for them to complete.
StringfailOnSnapshotError
If checked, the build will be marked as failed if there are any errors running your configured performance tests. If unchecked, any errors creating tests will be treated as warnings and not fail the build.
booleanfailOnResults
If checked, the build will wait for your configured tests to complete (may take 30 seconds to a few minutes) and pass/fail based on the results configured below. If unchecked, your configured tests will run, but the build will not wait for the tests to complete nor fail this step based on any results (useful for historical change logging of your site in the Rigor Optimization application).
booleanperformanceScore
Optional
Fail the build if any test reports an overall performance score lower than this value (1-100)
StringcriticalNumber
Optional
Fail the build if any test has more than this # of critical first party content defects found.
Note: You can customize when critical defects occur by customizing your Defect Check Policy. Learn more in this article.
StringfoundDefectIds
Optional
Fail the build if any of the listed defect IDs (comma separated) are found for any first party content items in any configured test.
Note: You can locate any defect ID at the top of any defect detail page in your results, or in the Knowledge Base. See Example.
StringenforcePerformanceBudgets
Optional
Fail the build if any test exceeds its performance budgets
booleantotalContentSize
StringtotalFoundItems
StringtestTimeoutSeconds
Timeout in seconds to wait for all configured performance tests to complete. Defaults to 300 seconds (5 minutes).
This value is only used if Fail build based on test results is enabled.
String$class: 'Rollback'apiKey
StringappName
String$class: 'RollbackBuilder'basePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
StringnumberOfChangesetsToRollback (optional)
Stringpassword (optional)
StringrollbackLastHours (optional)
StringrollbackToDate (optional)
StringrollbackToTag (optional)
StringrollbackType (optional)
Stringurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
String$class: 'RqmBuilder'collectionStrategy
$class: 'RqmTestSuiteExectionRecordCollectionStrategy'executionRecordName
StringplanName
StringprojectName
StringiterativeTestCaseBuilders
$class: 'RubyMotionBuilder'platform
StringrakeTask
StringoutputStyle
StringoutputFileName
StringuseBundler
booleaninstallCocoaPods
booleanneedClean
booleanoutputResult
booleandeviceName
StringsimulatorVersion
StringenvVars
String$class: 'RunApplicationAction'applicationName
Application selection is mandatory
Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
StringactionName
Application Action selection is mandatory
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringrunFromAlmBuilderalmServerName
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringalmTestSets
StringalmRunResultsMode
StringalmTimeout
StringalmRunMode
StringalmRunHost
StringisFilterTestsEnabled (optional)
booleanfilterTestsModel (optional)
blockedCheckbox
booleanfailedCheckbox
booleannotCompletedCheckbox
booleannoRunCheckbox
booleanpassedCheckbox
booleantestName (optional)
String$class: 'RunFromFileBuilder'fsTests
StringfileSystemTestSetModel
fileSystemTestSet
tests
StringparallelRunnerEnvironments
environment
StringenvironmentType
StringsummaryDataLogModel
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringscriptRTSSetModel
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringisParallelRunnerEnabled (optional)
booleanuftSettingsModel (optional)
selectedNode (optional)
StringnumberOfReruns (optional)
StringcleanupTest (optional)
StringonCheckFailedTest (optional)
StringfsTestType (optional)
StringrerunSettingsModels (optional)
test (optional)
Stringchecked (optional)
booleannumberOfReruns (optional)
intcleanupTest (optional)
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsAutActions (optional)
StringfsDeviceId (optional)
StringfsDevicesMetrics (optional)
StringfsExtraApps (optional)
StringfsInstrumented (optional)
StringfsJobId (optional)
StringfsLaunchAppName (optional)
StringfsManufacturerAndModel (optional)
StringfsOs (optional)
StringfsPassword (optional)
StringfsReportPath (optional)
StringfsTargetLab (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringfsUserName (optional)
StringignoreErrorStrings (optional)
StringmcServerName (optional)
StringmcTenantId (optional)
StringperScenarioTimeOut (optional)
StringproxySettings (optional)
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
hudson.util.Secret
useSSL (optional)
boolean$class: 'RunFromSrfBuilder'srfTestId
StringsrfTagNames
StringsrfReleaseNumber
StringsrfBuildNumber
StringsrfTunnelName
StringsrfCloseTunnel
booleansrfTestParameters
name
Stringvalue
StringshouldGetOnlyFirstValueFromJson
boolean$class: 'RunInCloudBuilder'projectId
The Bitbar Cloud project in which to start the new test run.
StringappPath
StringtestPath
StringdataPath
StringtestRunName
Stringscheduler
StringtestRunner
StringdeviceGroupId
Stringlanguage
StringscreenshotsDirectory
StringkeyValuePairs
StringwithAnnotation
StringwithoutAnnotation
StringtestCasesSelect
StringtestCasesValue
StringfailBuildIfThisStepFailed
booleanwaitForResultsBlock
testRunStateCheckMethod (optional)
HOOK_URL, API_CALLdownloadScreenshots (optional)
booleanforceFinishAfterBreak (optional)
booleanhookURL (optional)
StringresultsPath (optional)
StringwaitForResultsTimeout (optional)
inttestTimeout
StringcredentialsId
StringcloudUrl
StringcloudUIUrl
StringframeworkId
longosType
IOS, ANDROID, DESKTOP, UNDEFINEDruntpjobprojectId (optional)
StringjobId (optional)
StringwaitJobFinishSeconds (optional)
int$class: 'RunLoadRunnerScript'scriptsPath
String$class: 'RunPcTestBuildStep'almPassword (optional)
StringalmUser (optional)
Stringdomain (optional)
StringfailIfTaskFails (optional)
booleanoutputDir (optional)
StringpollingInterval (optional)
intpostRunActionString (optional)
Stringproject (optional)
StringretryCollateAndAnalysisAttempts (optional)
intretryCollateAndAnalysisFlag (optional)
booleanretryCollateAndAnalysisInterval (optional)
intretryCount (optional)
intretryInterval (optional)
intretryIntervalMultiplier (optional)
doubletestLabPath (optional)
StringtestPlanPath (optional)
Stringtimeout (optional)
inttimeslotDuration (optional)
intvudsMode (optional)
boolean$class: 'RunProcess'apiKey
StringappName
Stringcommand
String$class: 'RunTestSetBuildStep'domain
Stringproject
StringrunMode
Stringhost
StringtestSets
StringoutputDirPath
StringtimeOut
int$class: 'RunUftTestBuildStep'testPath
StringoutputDirPath
String$class: 'RunscopeBuilder'triggerEndPoint
StringaccessToken
Stringtimeout
ints3CopyArtifactprojectName
StringbuildSelector
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacefilter
StringexcludeFilter
Stringtarget
Stringflatten
booleanoptional
boolean$class: 'SASUnitPlugInBuilder'This is the Jenkins Plug-In for SASUnit the unit testing framework for SAS.
sasunitBatch
StringdoxygenBatch
Please enter the relative path to the executable to create the doxygen report
StringsasunitVersion
Please pick a SASUnit installation that shall be used.
To add an installation please go to Jenins->Manage Jenkins->Setting or follow this link.
StringcreateDoxygenDocu
boolean$class: 'SBuild'sbuildVersion
Stringtargets
StringbuildFiles
Stringoptions
StringscmSkipdeleteBuild (optional)
booleanskipPattern (optional)
StringsilkcentralprojectId
intexecDefIds
StringbuildNumberUsageOption (optional)
intcollectResults (optional)
booleancontOnErr (optional)
booleandelay (optional)
intignoreSetupCleanup (optional)
booleanjobName (optional)
StringspecificPassword (optional)
StringspecificServiceURL (optional)
StringspecificUser (optional)
StringuseSpecificInstance (optional)
boolean$class: 'SConsBuilderCommand'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
StringcommandScript
String$class: 'SConsBuilderScriptFile'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
Stringsconsscript
String$class: 'SMABuilder'validateEnabled
booleanusername
Stringpassword
StringsecurityToken
StringserverType
StringtestLevel
StringprTargetBranch
String$class: 'SQLPlusRunnerBuilder'credentialsId
Stringinstance
StringscriptType
Stringscript
StringscriptContent
| SELECT sysdate from dual; show user; |
StringcustomOracleHome (optional)
StringcustomSQLPlusHome (optional)
StringcustomTNSAdmin (optional)
String$class: 'SSHBuilder'siteName
Stringcommand
StringexecEachLine
Execute each line in the script individually.
By default, all of the commands are concatenated into a single "command" issued over a single SSH exec channel. Selecting this option causes each line to be executed over it's own SSH exec channel, each of which is part of the same session.
This is useful in certain cases where the commands cannot be concatenated into a single script executed at one time, for example, when issuing commands using the sourceforge.net shell.
If unsure, leave this box unchecked.
booleanhideCommand (optional)
boolean$class: 'SaltAPIBuilder'authtype
StringclientInterface
hookpost
Stringtag
Stringbatchfunction
Stringarguments
StringbatchSize
StringbatchWait
Stringtarget
Stringtargettype
Stringlocalfunction
Stringarguments
Stringtarget
Stringtargettype
Stringblockbuild (optional)
booleanjobPollTime (optional)
intminionTimeout (optional)
intsubsetfunction
Stringarguments
Stringsubset
Stringtarget
Stringtargettype
Stringrunnerfunction
Stringarguments
Stringmods
Stringpillarvalue
StringcredentialsId
Stringservername (optional)
StringsaveEnvVar (optional)
booleansaveFile (optional)
booleanskipValidation (optional)
boolean$class: 'SbtPluginBuilder'name
StringjvmFlags
StringsbtFlags
Stringactions
StringsubdirPath
String$class: 'ScaleProcess'apiKey
StringappName
StringprocessType
Stringquantity
int$class: 'ScriptBuildStep'buildStepId
StringscriptBuildStepArgs
defineArgs
booleanbuildStepArgs
arg
Stringtokenized
boolean$class: 'ScriptExecutionBuilder'autoScript
Type the Perfecto repository path name.
For example, to find a script called AndroidScript located in the my scripts folder, in the PRIVATE subarea, type or select PRIVATE:my scripts/AndroidScript.
After selecting or entering the script name you should click Refresh parameters to refresh the script parameters.
Note that values entered for some parameter will be preserved for same parameter name/type of the newly selected script.
StringscriptParams
Click the Refresh parameters list button to display the runtime parameters defined in the script.
Fill in the parameter values as specified below for each type.
String/integer: simply type them
For example, "appIdentifier(string)=Perfecto Mobile OSE"
Device parameter: The value should be the device id of the required device
Use the "Device and Media parameter value assistance" to find the id. For example: "DUT(Device)=TA8830NFLG"
Media/DataTable parameter: Enter the repository key and optionally the workspace location of the file to upload, separated by a semicolon.
For example, "PRIVATE:myfolder/TestApp.apk;mybuild\TestApp.apk"
Use the "Device and Media parameter value assistance" to find the repository path.
How to use the "Device and Media parameter value assistance":
NOTICE: It is not recommended to use runtime parameter of type Handset (Device) ; the specified device may be unavailable at runtime. Instead, use the Select device command within your script to select an available device at runtime. Click here for more information.
Device: Scroll and select the required device. Click on "Copy to clipboard" and then copy the id and paste into the parameter.
Media: Find the repository path by typing the path in the field. Select an item from the list, then use the clipboard to copy/paste the value into the parameter.
Stringid
StringautoMedia
Select the repository item path, copy it, then insert as a repository path of a parameter of type Media.
String$class: 'SecurityCheckerBuilder'$class: 'SeleniumAutoExecBuilder'serverUrl
String$class: 'SeleniumBuilderBuilder'scriptFile
StringparallelSettings
threadPoolSize
int$class: 'SelfServiceBookmarkBuilder'delphixEngine
StringdelphixBookmark
StringdelphixOperation
StringdelphixContainer
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SelfServiceContainerBuilder'delphixEngine
StringdelphixEnvironment
StringdelphixOperation
StringdelphixBookmark
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SemanticVersioningBuilder'parser
StringnamingStrategy
StringuseJenkinsBuildNumber
booleanenvVariable
String$class: 'SendMessageBuildStep'message
Stringfilepath
Stringrecipients
id
StringsensediaApiDeployenviromentName
Stringrevision
StringsensediaApiJsonapiId
StringsensediaApiQArevisionNumber
intdestination
booleanlogInterceptor
booleanresourceOutOfSize
booleanresourceSize
intshellBy default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
command
StringsignAndroidApksandroidHome (optional)
zipalign tool. You can also set the
ANDROID_HOME environment variable in your Jenkins system or node configuration. E.g.,
/usr/local/android-sdk.
StringapksToSign (optional)
myApp/build/outputs/apk/myApp-unsigned.apk or
**/*-unsigned.apk or
app1/**/*-unsigned.apk, app2/**/*-unsigned.apk.
StringarchiveSignedApks (optional)
SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk, where
myApp-unsigned.apk is a directory named for the input unsigned APK.
booleanarchiveUnsignedApks (optional)
booleankeyAlias (optional)
Key Store ID references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
StringkeyStoreId (optional)
StringsignedApkMapping (optional)
unsignedApkNameDirunsignedApkSiblingskipZipalign (optional)
booleanzipalignPath (optional)
zipalign executable this build step should
use to align the target APKs. You can also set the
ANDROID_ZIPALIGN environment variable in your Jenkins system or node configuration. E.g.,
/opt/android-tools/bin/zipalign
String$class: 'SilkPerformerBuilder'projectLoc
Stringworkload
StringsuccessCriteria
userType
StringmeasureCategory
StringmeasureType
StringmeasureName
StringvalueType
StringoperatorType
StringchosenValue
String$class: 'SingleConditionalBuilder'buildStep
$class: 'SkytapBuilder'action
$class: 'AddConfigurationToProjectStep'configurationID
StringconfigurationFile
StringprojectID
StringprojectName
String$class: 'AddTemplateToProjectStep'templateID
StringtemplateFile
StringprojectID
StringprojectName
String$class: 'ChangeConfigurationStateStep'configurationID
StringconfigurationFile
StringtargetRunState
StringhaltOnFailedShutdown
boolean$class: 'ChangeContainerStateStep'containerID
StringcontainerFile
StringtargetContainerAction
String$class: 'ChangeVMContainerHostStatus'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerHostStatus
String$class: 'ConnectToVPNTunnelStep'configurationID
StringconfigurationFile
StringconfigurationNetworkName
StringvpnID
String$class: 'CreateConfigurationStep'templateID
StringtemplateFile
StringconfigName
StringconfigFile
String$class: 'CreateContainerStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerRegistryName
StringrepositoryName
StringcontainerName
If no name is provided, the container will be named New_Container_[timestamp]
StringcontainerCommand
If no command is provided, will default to using the command in the image spec (if applicable).
StringexposeAllPorts
booleancontainerSaveFilename
String$class: 'CreatePublishURLStep'configurationID
StringconfigurationFile
StringurlSaveFilename
StringportalName
StringpermissionOption
Don't Publish: The Sharing Portal URL will not be available to the user in any way.
View Only: User can view the VM through the Sharing Portal URL. No mouse or keyboard control is allowed, and desktop resizing is disabled.
Use:User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed.
Run, Suspend: User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed, and the user can also run the machine if it is in a stopped or suspended state.
StringhasPassword
urlPassword
String$class: 'CreatePublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'CreateTemplateFromConfigurationStep'configurationID
StringconfigurationFile
StringtemplateName
StringtemplateDescription
StringtemplateSaveFilename
String$class: 'DeleteConfigurationStep'configurationID
StringconfigurationFile
String$class: 'DeleteContainerStep'containerID
StringcontainerFile
String$class: 'GetContainerMetaDataStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerName
StringcontainerDataFile
String$class: 'ListPublishedURLForConfigurationStep'configurationID
StringconfigurationFile
StringurlName
StringurlFile
String$class: 'ListVMPublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'MergeTemplateIntoConfigurationStep'configurationID
StringconfigurationFile
StringtemplateID
StringtemplateFile
StringconfigFile
String$class: 'NetworkConnectStep'sourceNetworkConfigurationID
StringtargetNetworkConfigurationID
StringsourceNetworkConfigurationFile
StringtargetNetworkConfigurationFile
StringsourceNetworkName
StringtargetNetworkName
String$class: 'SmartFrogBuilder'smartFrogName
StringdeployHost
Stringhosts
StringsfUserHome
StringsfUserHome2
StringsfUserHome3
StringsfUserHome4
StringsfOpts
StringbuilderId
StringuseAltIni
booleansfIni
StringsfScriptSource
$class: 'FileScriptSource'scriptName
StringscriptPath
String$class: 'StringScriptSource'scriptName
StringscriptContent
String$class: 'SnapshotBuilder'xStudioPath
StringxStudioLicensePath
StringvagrantBox
Stringoverwrite
booleanpreInstallScriptPath
StringpostSnapshotScriptPath
StringresourceDirectoryPath
Stringdependencies
StringsnapshotFilesToDelete
StringinstallScriptSettings
org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$InstallScriptSettings
startupFileSettings
org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$StartupFileSettings
snykSecurityadditionalArguments (optional)
Additional runtime arguments that will be used to invoke the Snyk CLI. See the Snyk CLI help page for more details.
Use the standalone double-dash -- to pass arguments to the build tool invoked by the Snyk CLI. For example:
-- -Pprofile -Dkey=value for Maven projects.-- --configuration runtime for Gradle projects.-- -Dkey=value for SBT projects.StringfailOnIssues (optional)
The "When issues are found" selection specifies if builds should be failed or continued based on issues found by Snyk.
The corresponding CLI option for severity parameter: --severity-threshold
booleanmonitorProjectOnBuild (optional)
Monitor the project on every build by taking a snapshot of its current dependencies on Snyk.io. Selecting this option will keep you notified about newly disclosed vulnerabilities and remediation options in the project.
booleanorganisation (optional)
The Snyk organisation in which this project should be tested and monitored. Leave empty to use your default organisation.
The corresponding CLI option for this parameter: --org
StringprojectName (optional)
A custom name for the Snyk project created for this Jenkins project on every build. Leave empty for the project's name to be detected in the manifest file.
The corresponding CLI option for this parameter: --project-name
Stringseverity (optional)
StringsnykInstallation (optional)
Ensures that the selected version of Snyk tools are installed. In addition, the Snyk tools will be added at the start of the PATH environment variable during builds.
If no Snyk installations have been defined in the Jenkins system config, then none of the above steps will take place.
StringsnykTokenId (optional)
The ID for the API token from the Credentials plugin to be used to authenticate to Snyk. The type of the credential must be "Snyk API token"
StringtargetFile (optional)
The path to the manifest file to be used by Snyk. Leave empty for Snyk to auto-detect the manifest file in the project's root folder.
The corresponding CLI option for this parameter: --file
StringaddALMOctaneSonarQubeListenerpushCoverage (optional)
booleanpushVulnerabilities (optional)
booleansonarServerUrl (optional)
StringsonarToken (optional)
String$class: 'SonarRunnerBuilder'additionalArguments (optional)
StringinstallationName (optional)
StringjavaOpts (optional)
Stringjdk (optional)
Stringproject (optional)
Stringproperties (optional)
StringsonarScannerName (optional)
Stringtask (optional)
String$class: 'SoundsBuildTask'afterDelayMs
StringsoundSource
selectedSound
Stringvalue
INTERNAL, URLsoundUrl
String$class: 'SparkNotifyBuilder'disable
booleanmessageType
StringroomList
rName
StringrId
StringmessageContent (optional)
StringcredentialsId (optional)
StringspringBootselectedIDs (optional)
StringartifactId (optional)
Stringautocomplete (optional)
StringbootVersion (optional)
Stringdescription (optional)
StringgroupId (optional)
StringjavaVersion (optional)
Stringlanguage (optional)
Stringpackaging (optional)
StringprojectName (optional)
Stringtype (optional)
String$class: 'SrfServerSettingsBuilder'credentialsId
StringsrfServerName
StringsrfProxyName
StringsrfTunnelPath
StringsseBuildalmServerName
StringalmProject
StringcredentialsId
StringclientType
StringalmDomain
StringrunType
StringalmEntityId
StringtimeslotDuration
StringcdaDetails (optional)
deploymentAction
StringdeployedEnvironmentName
StringdeprovisioningAction
Stringdescription (optional)
StringenvironmentConfigurationId (optional)
StringpostRunAction (optional)
StringosfBuilderSuiteStandaloneSonarLintersourcePatterns (optional)
sourcePattern
StringexcludePatterns
excludePattern
StringreportPath (optional)
String$class: 'StartBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstartETConfigure and start a preconfigured ECU-TEST installation.
Pipeline usage
startET(String toolName) : void
startET(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debug, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start(String toolName) : void
ETInstance.start(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debug, boolean keepInstance, boolean updateUserLibs) : void
startET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startET installation: instance.installation, workspaceDir: 'C:\\Data'
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.start()
toolName
StringdebugMode (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepInstance (optional)
booleansettingsDir (optional)
Stringtimeout (optional)
StringupdateUserLibs (optional)
booleanworkspaceDir (optional)
String$class: 'StartGrid'url
StringcloudTestServerID
Stringname
StringtimeOut
int$class: 'StartRSDB'url
StringcloudTestServerID
Stringname
StringtimeOut
intstartTSConfigure and start Tool-Server.
Pipeline usage
startTS(String toolName) : void
startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS(String toolName) : void
ETInstance.startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
startTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.startTS()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepInstance (optional)
booleantcpPort (optional)
Stringtimeout (optional)
StringtoolLibsIni (optional)
String$class: 'StartTestEnvironment'url
StringcloudTestServerID
Stringname
StringtimeOut
int$class: 'StopBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstopETShutdown ECU-TEST.
Pipelines usage:
stopET(String toolName) : void
stopET(String toolName, int timeout) : void
ETInstance.stop(String toolName) : void
ETInstance.stop(String toolName, int timeout) : void
stopET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopET installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stop()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
timeout (optional)
String$class: 'StopGrid'url
StringcloudTestServerID
Stringname
String$class: 'StopRSDB'url
StringcloudTestServerID
Stringname
StringstopTSShutdown Tool-Server.
Pipelines usage:
stopTS(String toolName) : void
stopTS(String toolName, int timeout) : void
ETInstance.stopTS(String toolName) : void
ETInstance.stopTS(String toolName, int timeout) : void
stopTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stopTS()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
timeout (optional)
String$class: 'StopTestEnvironment'url
StringcloudTestServerID
Stringname
String$class: 'StudioToolsBuilder'name
Stringoperation
StringprojectDir
StringoutputArchiveFile
StringextendedClassPath
StringoverwriteOutput
booleanTRAPropertyFIle
StringtopazSubmitFreeFormJclconnectionId
StringcredentialsId
StringmaxConditionCode
Stringjcl
StringtopazSubmitJclMembersconnectionId
StringcredentialsId
StringmaxConditionCode
StringjclMember
String$class: 'SvChangeModeBuilder'serverName
Stringforce
booleanmode
OFFLINE, SIMULATING, STAND_BY, LEARNINGdataModel
selectionType
BY_NAME, NONE, DEFAULTdataModel
StringperformanceModel
selectionType
BY_NAME, NONE, OFFLINE, DEFAULTperformanceModel
StringserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SvDeployBuilder'serverName
Stringforce
booleanservice
StringprojectPath
StringprojectPassword
StringfirstAgentFallback
boolean$class: 'SvExportBuilder'serverName
Stringforce
booleantargetDirectory
StringcleanTargetDirectory
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringswitchToStandByFirst
booleanarchive
boolean$class: 'SvUndeployBuilder'serverName
StringcontinueIfNotDeployed
booleanforce
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SyncBuilder'packageid
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
Stringoptions
Stringfilter
StringpackageVersion
StringisolationLevel
StringupdateScript
booleansqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'SyncStepBuilder'packageId
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
hudson.util.Secret
compareOptions (optional)
StringtransactionIsoLvl (optional)
String$class: 'SystemGroovy'Executes a system groovy script similarly to hudson_url/script. The script is always executed on master.
Predefined variables:
build
AbstractBuild.
launcher
Launcher.
listener
BuildListener.
out
PrintStream (
listener.logger).
source
$class: 'FileSystemScriptSource'scriptFile
String$class: 'StringSystemScriptSource'script
script
Stringsandbox
booleanclasspath
path
Stringbindings (optional)
Define variable bindings (in the properties file format). Specified variables can be addressed from the script.
String$class: 'TATestRunRegistrationBuildStep'This step registers new test run with given category and sets the 'dtTestrunID' build variable.
category
Stringplatform
Stringtanaguruname
Stringscenario
StringurlToAudit
StringurlTanaguruWebService
StringperformanceUnstableMark
intperformanceFailedMark
intproxy_uri
Stringproxy_username
Stringproxy_password
String$class: 'TarGzDeployment'apiKey
StringappName
StringtargzPath
StringprocfilePath
String$class: 'TattletaleBuilder'inputDirectory
StringoutputDirectory
Stringtestcompletetestsuite (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringcommandLineArguments (optional)
StringexecutorType (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleanlaunchConfig (optional)
project (optional)
Stringroutine (optional)
Stringtest (optional)
Stringunit (optional)
Stringvalue (optional)
StringlaunchType (optional)
Stringproject (optional)
StringpublishJUnitReports (optional)
booleanroutine (optional)
StringsessionScreenResolution (optional)
Stringtest (optional)
Stringtimeout (optional)
Stringunit (optional)
StringuseActiveSession (optional)
booleanuseTCService (optional)
booleanuseTimeout (optional)
booleanuserName (optional)
StringuserPassword (optional)
String$class: 'TeamPendingStatusBuildStep'$class: 'TelegramBotBuilder'message
String$class: 'TelerikAppBuilder'applicationId
StringaccessToken
hudson.util.Secret
configuration
StringbuildSettingsiOS
mobileProvisionIdentifieriOS
StringcodesigningIdentityiOS
StringbuildSettingsAndroid
codesigningIdentityAndroid
StringbuildSettingsWP
boolean$class: 'TerminateBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
Stringdelete
boolean$class: 'TestBuilder'packageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
StringrunTestSet
value
StringrunOnlyParams
StringgenerateTestData
sqlgenPath
Stringoptions
Stringfilter
StringpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringtestSource
value
scaproject, socartifactprojectPath
Stringpackageid
StringpackageVersion
String$class: 'TestCompositionRunner'url
StringcloudTestServerID
Stringcomposition
StringdeleteOldResults
maxDaysOfResults
intadditionalOptions
Stringthresholds
transactionname
Stringthresholdname
Stringthresholdvalue
Stringthresholdid
StringgeneratePlotCSV
booleantestFoldertestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTIONrecursiveScan (optional)
booleanscanMode (optional)
PACKAGES_ONLY, PROJECTS_ONLY, PACKAGES_AND_PROJECTStestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestLinkBuilder'testLinkName
StringtestProjectName
StringtestPlanName
StringplatformName
StringbuildName
StringcustomFields
StringtestPlanCustomFields
StringexecutionStatusNotRun
booleanexecutionStatusPassed
booleanexecutionStatusFailed
booleanexecutionStatusBlocked
booleansingleBuildSteps
$class: 'TestOdysseyBuilder'jobId
StringprojectId
StringminPassPercentage
StringtestPackagetestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
StringtestProjecttestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTIONtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestRunner'stack
Stringbranch
StringtestNames
Stringundeploy
booleanapiKey
String$class: 'TestStepBuilder'packageId
StringserverType
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
hudson.util.Secret
runTestMode
StringrunTests
StringcompareOptions (optional)
StringdgenFile (optional)
StringgenerateTestData (optional)
boolean$class: 'TestStudioAPITestBuilder'apiRunnerPath (optional)
Stringproject (optional)
Stringtest (optional)
StringstartFrom (optional)
StringstopAfter (optional)
Stringvariable (optional)
StringdontSaveContexts (optional)
booleantestAsUnit (optional)
boolean$class: 'TestStudioTestBuilder'artOfTestRunnerPath
StringtestPath
StringsettingsPath
StringdateFormat
| Letter | Date or Time Component | Presentation | Examples |
|---|---|---|---|
| G | Era designator | Text | AD |
| y | Year | Year | 1996; 96 |
| Y | Week year | Year | 2009; 09 |
| M/L | Month in year | Month | July; Jul; 07 |
| w | Week in year | Number | 27 |
| W | Week in month | Number | 2 |
| D | Day in year | Number | 189 |
| d | Day in month | Number | 10 |
| F | Day of week in month | Number | 2 |
| E | Day in week | Text | Tuesday; Tue |
| u | Day number of week | Number | 1 |
| a | Am/pm marker | Text | PM |
| H | Hour in day (0-23) | Number | 0 |
| k | Hour in day (1-24) | Number | 24 |
| K | Hour in am/pm (0-11) | Number | 0 |
| h | Hour in am/pm (1-12) | Number | 12 |
| m | Minute in hour | Number | 30 |
| s | Second in minute | Number | 55 |
| S | Millisecond | Number | 978 |
| z | Time zone | General time zone | Pacific Standard Time; PST; GMT-08:00 |
| Z | Time zone | RFC 822 time zone | -0800 |
| X | Time zone | ISO 8601 time zone | -08; -0800; -08:00 |
| Input string | Pattern |
|---|---|
| 2001.07.04 AD at 12:08:56 PDT | yyyy.MM.dd G 'at' HH:mm:ss z |
| Wed, Jul 4, '01 | EEE, MMM d, ''yy |
| 12:08 PM | h:mm a |
| 12 o'clock PM, Pacific Daylight Time | hh 'o''clock' a, zzzz |
| 0:08 PM, PDT | K:mm a, z |
| 02001.July.04 AD 12:08 PM | yyyyy.MMMM.dd GGG hh:mm aaa |
| Wed, 4 Jul 2001 12:08:56 -0700 | EEE, d MMM yyyy HH:mm:ss Z |
| 010704120856-0700 | yyMMddHHmmssZ |
| 2001-07-04T12:08:56.235-0700 | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| 2001-07-04T12:08:56.235-07:00 | yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| 2001-W27-3 | YYYY-'W'ww-u |
StringprojectRoot (optional)
StringtestAsUnit (optional)
booleanoutputPath (optional)
String$class: 'TestSwarmBuilder'testswarmServerUrl
StringjobName
StringuserName
StringauthToken
StringmaxRuns
StringchooseBrowsers
StringpollingIntervalInSecs
StringtimeOutPeriodInMins
StringminimumPassing
StringtestSuiteList
testName
StringtestUrl
StringtestCacheCracker
booleandisableTest
booleantestweaverprojectPath
StringexperimentName
StringjUnitReportDirectory
StringhtmlReportDirectory (optional)
StringinstrumentView (optional)
booleannamespacePattern (optional)
StringparameterValues (optional)
StringrunScenarioLimit (optional)
intrunTimeLimit (optional)
longsilverParameters (optional)
String$class: 'TesteinRunBuilder'targetType
StringtargetId
StringdownloadReport
booleandownloadLogs
boolean$class: 'TesteinUploadStepBuilder'enableJs
jsFilePath
StringjsonFilePath
StringenableJar
jarFilePath
Stringoverwrite
boolean$class: 'TestingBotBuilder'name
String$class: 'TestiniumPlugin'projectId (optional)
intplanId (optional)
intabortOnError (optional)
booleanabortOnFailed (optional)
booleanfailOnTimeout (optional)
booleanignoreInactive (optional)
booleantimeoutSeconds (optional)
int$class: 'TestopiaBuilder'testopiaInstallationName
StringtestRunId
intsingleBuildSteps
convertTestsToRunframework
Stringformat
Stringdelimiter
StringtotaltestUTconnectionId
StringcredentialsId
StringprojectFolder
StringtestSuite
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
Stringjcl
StringccClearStats (optional)
booleanccDB2 (optional)
booleanccPgmType (optional)
StringccRepo (optional)
StringccSystem (optional)
StringccTestId (optional)
StringdeleteTemp (optional)
booleanhlq (optional)
StringhostPort (optional)
StringuseStubs (optional)
booleantotaltestenvironmentId
StringfolderPath
StringserverUrl
StringcredentialsId
StringaccountInfo (optional)
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
StringccThreshhold (optional)
inthaltAtFailure (optional)
booleanrecursive (optional)
booleanreportFolder (optional)
StringsonarVersion (optional)
StringsourceFolder (optional)
StringstopIfTestFailsOrThresholdReached (optional)
booleanuploadToServer (optional)
boolean$class: 'ToxBuilder'toxIni
Stringrecreate
booleantoxenvPattern
String$class: 'TptPlugin'exe
StringexePaths
Stringarguments
StringisTptMaster
booleanslaveJob
StringslaveJobCount
StringslaveJobTries
StringtptBindingName
StringtptPort
StringexecutionConfiguration
tptFile
Stringconfiguration
StringtestdataDir
StringreportDir
StringenableTest
booleantimeout
longtestSet
StringtptStartUpWaitTime
StringenableJunit
booleanjUnitreport
StringjUnitLogLevel
NONE, ERROR, WARNING, INFO, ALL$class: 'TptPluginSlave'exePaths
StringtptBindingName
StringtptPort
StringtptStartUpWaitTime
StringtricentisCItricentisClientPath (optional)
Stringendpoint (optional)
StringconfigurationFilePath (optional)
String$class: 'TriggerBuilder'configs
projects
Stringblock
buildStepFailureThreshold
StringunstableThreshold
StringfailureThreshold
StringconfigFactories
$class: 'AllNodesBuildParameterFactory'$class: 'AllNodesForLabelBuildParameterFactory'name
StringnodeLabel
StringignoreOfflineNodes
boolean$class: 'BinaryFileParameterFactory'This implementation does not interpret the contents of those files, and instead it simply gets passed and placed into the workspace of the triggered project(s) under the name specified here.
This is useful, for example, when you have a portion of the job that can be split into concurrently executable subtasks. In such a situation, you can have an earlier step produce subtask work units by packaging necessary stuff into individual files, then use this mode to execute them all in parallel.
parameterName
StringfilePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'CounterBuildParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'CounterGeneratorParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'FileBuildParameterFactory'filePattern
Stringencoding
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'FileGeneratorParameterFactory'filePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'MultipleBinaryFileParameterFactory'parametersList
org.jenkinsci.plugins.parallel_test_executor.MultipleBinaryFileParameterFactory$ParameterBinding
noFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'NodeListBuildParameterFactory'name
StringnodeListString
Stringconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggerred job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
boolean$class: 'TwitterPublisher'tokenCredentialsID
StringconsumerCredentialsID
StringtweetText
StringUiPathPackversion
AutoVersionCustomVersiontext
StringprojectJsonPath
StringoutputPath
String$class: 'UnicornValidationBuilder'unicornUrl
StringsiteUrl
StringmaxErrorsForStable
StringmaxWarningsForStable
StringmaxErrorsForUnstable
StringmaxWarningsForUnstable
String$class: 'UninstallBuilder'packageId
StringfailOnUninstallFailure
boolean$class: 'UnitTestBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringobjects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringowner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringtxt
booleanxml
boolean$class: 'Unity3dBuilder'For projects that use Unity3d as the build system.
This causes Jenkins to invoke the Unity3d Editor with the given command line arguments.
A non-zero exit code from Unity3d makes Jenkins mark the build as a failure.
unity3dName
StringargLine
-quit -batchmode -executeMethod YourEditorScript.YourBuildMethod [-nographics] or
-quit -batchmode -buildWindowsPlayer path/to/your/build.exe or
-quit -batchmode -buildOSXPlayer path/to/your/build.app
If this value isn't set, the globalArgLine is used.
Note: we make little to no attempt to detect conflicting arguments or arguments not suitable to the platform neither at configuration nor at runtime.
If the specified command line contains no -projectpath argument, the plugin automatically adds one with the proper parameter (the workspace of the project on the target machine). This is to make sure unity builds the proper project. Otherwise unity would reuse the last opened project. You can override it, but this hasn't been thoroughly tested.
If your build agent have multiple executors (which you should probably do), it is highly recommended to make use of a -logFile argument to avoid letting Unityed write to the standard editor.log concurrently. A recommended practise is to use something like -logFile "$WORKSPACE/unity3d_editor.log".
See the official Editor command line arguments documentation.
StringunstableReturnCodes
Stringunshelveshelf
Stringresolve
Stringtidy
booleanignoreEmpty
boolean$class: 'UpdateBox'cloud
Stringworkspace
Stringbox
Stringvariables
StringazureVMSSUpdateazureCredentialsId
StringresourceGroup
Stringname
StringimageReference
id (optional)
Resource ID or VHD URI of the custom image.
Example Resource ID: /subscriptions/your-subscription-id/resourceGroups/your-resource-group/providers/Microsoft.Compute/images/your-image-name
Example VHD URI: http://your-storage-account.blob.core.windows.net/vhds/your-disk-image.vhd
Stringoffer (optional)
Stringpublisher (optional)
Stringsku (optional)
Stringversion (optional)
StringazureVMSSUpdateInstancesazureCredentialsId
StringresourceGroup
Stringname
StringinstanceIds
,'.
String$class: 'UpdateProjectBuilder'$class: 'UploadAppBuildStep'applicationLocation
StringkeystoreInfo
keystoreLocation
StringkeystorePassword
StringkeyAlias
StringkeyPassword
StringextraArguments
touchId
booleancamera
booleanuuid
String$class: 'UploadAppBuilder'mcServerName
StringmcUserName
StringmcPassword
StringmcTenantId
StringproxySettings
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
hudson.util.Secret
applicationPaths
mcAppPath
Stringupload-pgyeruKey
StringapiKey
StringscanDir
Stringwildcard
StringinstallType
Stringpassword
StringupdateDescription
StringqrcodePath
StringenvVarsPath
Stringupload-pgyer-v2apiKey
StringscanDir
Stringwildcard
StringbuildName
StringbuildInstallType
StringbuildPassword
StringbuildUpdateDescription
StringqrcodePath
StringenvVarsPath
String$class: 'UploadJUnitTestResult'properties
java.lang.String>
uploadProgetPackagefeedName
StringgroupName
A string of no more than fifty characters:
StringpackageName
A string of no more than fifty characters:
Stringversion
Stringartifacts
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
StringcaseSensitive (optional)
org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
booleandefaultExcludes (optional)
booleandependencies (optional)
Stringdescription (optional)
Stringexcludes (optional)
Stringicon (optional)
Stringmetadata (optional)
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
Stringtitle (optional)
A string of no more than fifty characters
String$class: 'UpmergeBuilder'commitUsername
StringuTesterUrlListTaskinitialUrl
StringurlsWhiteList
StringrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
intuseMangouseSlaveNodes
StringnodeLabel
StringprojectId
StringfolderName
StringtestName
StringtestStatus
StringassignedTo
String$class: 'VB6Builder'projectFile
StringcompileConstants (optional)
StringoutDir (optional)
StringvCommanderaction
$class: 'VCommanderRequestNewServiceAction'payload
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderRunWorkflowAction'targetType
StringtargetName
StringworkflowName
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderWaitForRequestNewServiceAction'requestId
Stringtimeout
longpolling
long$class: 'VCommanderWaitForRunWorkflowAction'taskId
Stringtimeout
longpolling
long$class: 'VMGRAPI'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvAPIInput
StringvJsonInputFile
StringdeleteInputFile
booleanauthRequired
booleanapiType
StringdynamicUserId
booleanapiUrl
StringrequestMethod
StringadvConfig
booleanconnTimeout
intreadTimeout
int$class: 'VMGRLaunch'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvSIFName
StringvSIFInputFile
StringcredentialInputFile
StringdeleteInputFile
booleandeleteCredentialInputFile
booleanuseUserOnFarm
booleanauthRequired
booleanvsifType
StringuserFarmType
StringdynamicUserId
booleanadvConfig
booleanconnTimeout
intreadTimeout
intenvVarible
booleanenvVaribleFile
StringinaccessibleResolver
StringstoppedResolver
StringfailedResolver
StringdoneResolver
StringsuspendedResolver
StringwaitTillSessionEnds
booleanstepSessionTimeout
intgenerateJUnitXML
booleanextraAttributesForFailures
booleanstaticAttributeList
StringmarkBuildAsFailedIfAllRunFailed
booleanfailJobIfAllRunFailed
booleanenvSourceInputFile
StringvMGRBuildArchive
booleandeleteAlsoSessionDirectory
booleangenericCredentialForSessionDelete
booleanarchiveUser
StringarchivePassword
StringfamMode
StringfamModeLocation
StringnoAppendSeed
booleanmarkBuildAsPassedIfAllRunPassed
booleanfailJobUnlessAllRunPassed
booleanuserPrivateSSHKey
boolean$class: 'VSphereBuildStepContainer'buildStep
$class: 'Clone'sourceName
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringpowerOn
booleantimeoutInSeconds
intcustomizationSpec
String$class: 'ConvertToTemplate'vm
Stringforce
boolean$class: 'ConvertToVm'template
StringresourcePool
Stringcluster
String$class: 'Delete'vm
StringfailOnNoExist
boolean$class: 'DeleteSnapshot'vm
StringsnapshotName
Stringconsolidate
booleanfailOnNoExist
boolean$class: 'Deploy'template
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringcustomizationSpec
StringtimeoutInSeconds
intpowerOn
boolean$class: 'ExposeGuestInfo'vm
StringenvVariablePrefix
StringwaitForIp4
boolean$class: 'PowerOff'vm
StringevenIfSuspended
booleanshutdownGracefully
booleanignoreIfNotExists
booleangracefulShutdownTimeout (optional)
int$class: 'PowerOn'vm
StringtimeoutInSeconds
int$class: 'Reconfigure'vm
StringreconfigureSteps
$class: 'ReconfigureAnnotation'annotation (optional)
Stringappend (optional)
boolean$class: 'ReconfigureCpu'cpuCores
StringcoresPerSocket
String$class: 'ReconfigureDisk'diskSize
Stringdatastore
String$class: 'ReconfigureMemory'memorySize
String$class: 'ReconfigureNetworkAdapters'deviceAction
ADD, EDIT, REMOVEdeviceLabel
StringmacAddress
StringstandardSwitch
booleanportGroup
StringdistributedSwitch
booleandistributedPortGroup
StringdistributedPortId
String$class: 'Rename'oldName
StringnewName
String$class: 'RenameSnapshot'vm
StringoldName
StringnewName
StringnewDescription
String$class: 'RevertToSnapshot'vm
StringsnapshotName
String$class: 'SuspendVm'vm
String$class: 'TakeSnapshot'vm
StringsnapshotName
Stringdescription
StringincludeMemory
booleanserverName
String$class: 'VaddyPlugin'host
StringuserId
StringauthKey
StringcrawlId
StringapiServerUrl
StringproxyHost
StringproxyPort
String$class: 'VagrantDestroyCommand'vagrantFile
StringvagrantVm
String$class: 'VagrantProvisionCommand'vagrantFile
StringvagrantVm
Stringprovisioners
Stringparallel
boolean$class: 'VagrantSshCommand'vagrantFile
StringvagrantVm
Stringcommand
StringasRoot
boolean$class: 'VagrantUpCommand'vagrantFile
StringvagrantVm
StringdestroyOnError
booleanprovider
StringdontKillMe
boolean$class: 'ValgrindBuilder'valgrindExecutable
StringworkingDirectory
StringincludePattern
StringexcludePattern
StringoutputDirectory
StringoutputFileEnding
StringprogramOptions
Stringtool
$class: 'ValgrindToolHelgrind'historyLevel
String$class: 'ValgrindToolMemcheck'showReachable
booleanundefinedValueErrors
booleanleakCheckLevel
StringtrackOrigins
booleanvalgrindOptions
StringignoreExitCode
booleantraceChildren
booleanchildSilentAfterFork
booleangenerateSuppressions
booleansuppressionFiles
StringremoveOldReports
booleancrxValidatepackageIdFilters (optional)
**/*.zip
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zip
Matching packages will be validated in the order in which the filters are specified. At least one package must match each filter or the step will fail.
StringallowNonCoveredRoots (optional)
booleanforbiddenACHandlingModeSet (optional)
StringforbiddenExtensions (optional)
.jar
.zip
This field supports parameter tokens.
StringforbiddenFilterRootPrefixes (optional)
/apps/system
/apps/system/config
/apps/systemOfADown/config
StringlocalDirectory (optional)
StringpathsDeniedForInclusion (optional)
/apps/system/rep:policy
/etc/map/http/site_root_redirect
Use this test to safeguard specific paths or possible paths within unrestricted roots from overly broad workspace filters.
StringvalidationFilter (optional)
/etc # define /etc as the filter root
-/etc/packages(/.)? # exclude package paths
This field supports parameter tokens.
String$class: 'Validator'stack
Stringbranch
StringapiKey
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
StringvariablesPrefix
StringvariablesSuffix
StringemptyValue
Stringconfigs
name
Stringvalue
String$class: 'VectorCASTCommand'winCommand
StringunixCommand
String$class: 'VectorCASTSetup'environmentSetupWin
StringenvironmentSetupUnix
StringexecutePreambleWin
StringexecutePreambleUnix
StringenvironmentTeardownWin
StringenvironmentTeardownUnix
StringoptionUseReporting
booleanoptionErrorLevel
StringoptionHtmlBuildDesc
StringoptionExecutionReport
booleanoptionClean
booleanwaitLoops
longwaitTime
longmanageProjectName
StringjobName
StringnodeLabel
String$class: 'ViberNotifier'token (optional)
Stringsender (optional)
Stringmessage (optional)
String$class: 'ViewCloner'url
StringreplacePatternString
StringniewViewName
Stringpassword
Stringusername
String$class: 'VirtualenvBuilder'pythonName
Stringhome
Stringclear
booleansystemSitePackages
booleannature
Stringcommand
StringignoreExitCode
boolean$class: 'VsCodeMetricsBuilder'toolName
Stringfiles
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ assembly file path ]
StringoutputXML
Metrics results XML output file.
Command Line Argument: /out:[ output file path ]
Stringdirectory
Location to search for assembly dependencies.
You can specify multiple directories by separating them with new-line or space.
Command Line Argument: /directory:[ directory ]
StringsearchGac
Search the Global Assembly Cache for missing references.
Command Line Argument: /searchgac
booleanplatform
Location of framework assemblies, such as mscorlib.dll.
Command Line Argument: /platform:[ directory ]
Stringreference
Reference assemblies required for analysis.
You can specify multiple reference assemblies by separating them with new-line or space.
Command Line Argument: /reference:[ assembly file path ]
StringignoreInvalidTargets
Silently ignore invalid target files.
Command Line Argument: /ignoreinvalidtargets
booleanignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleancmdLineArgs
StringfailBuild
booleanvsTestcmdLineArgs (optional)
Stringenablecodecoverage (optional)
Enables data diagnostic adapter CodeCoverage in the test run.
Default settings are used if not specified using settings file.
Command Line Argument: /Enablecodecoverage
booleanfailBuild (optional)
booleanframework (optional)
Target .NET Framework version to be used for test execution.
Valid values are Framework35, Framework40 and Framework45.
Command Line Argument: /Framework: [ framework version ]
StringinIsolation (optional)
Runs the tests in an isolated process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
booleanlogger (optional)
Specify a logger for test results. For example, to log results into a Visual Studio Test Results File (TRX) use /Logger:trx.
Command Line Argument: /Logger:[ uri/friendlyname ]
Stringplatform (optional)
Target platform architecture to be used for test execution.
Valid values are x86, x64 and ARM.
Stringsettings (optional)
Run tests with additional settings such as data collectors.
Example: Local.RunSettings
Command Line Argument: /Settings:[ file name ]
StringtestCaseFilter (optional)
Run tests that match the given expression.
<Expression> is of the format <property>=<value>[||<Expression>].
Example: TestCategory=Nightly||Name=Namespace.ClassName.MethodName
The TestCaseFilter command line option cannot be used with the Tests command line option.
Command Line Argument: /TestCaseFilter:[ expression ]
StringtestFiles (optional)
Specify the path to your VSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line or space.
Stringtests (optional)
Run tests with names that match the provided values.
To provide multiple values, separate them by commas.
Example: TestMethod1,testMethod2
The /Tests command line option cannot be used with the /TestCaseFilter command line option.
Command Line Argument: /Tests:[ test name ]
StringuseVs2017Plus (optional)
This makes adjustments to the arguments for the sake of compatibility with Visual Studio 2017+.
Command Line Argument: /UseVs2017Plus:true
booleanuseVsixExtensions (optional)
This makes vstest.console.exe process use or skip the VSIX extensions installed (if any) in the test run.
Command Line Argument: /UseVsixExtensions:true
booleanvsTestName (optional)
String$class: 'WASBuildStep'additionalClasspath
StringappendTrace
booleancommands
StringjavaOptions
StringjobId
Stringlanguage
StringprofileScriptFiles
StringpropertiesFiles
StringrunIf
true.StringscriptFile
StringscriptParameters
StringtraceFile
StringwasServerName
Stringuser
Stringpassword
String$class: 'WakeUpIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'WarDeployment'apiKey
StringappName
StringwarPath
String$class: 'WarriorPluginBuilder'configType
StringgitConfigUrl
StringgitConfigCredentials
booleangitConfigTagValue
StringgitConfigCloneType
StringgitConfigUname
StringgitConfigPwd
StringgitConfigFile
StringsftpConfigIp
StringsftpConfigUname
StringsftpConfigPwd
StringsftpConfigFile
StringpythonPath
StringuploadExecLog
booleanuploadServerIp
StringuploadServerUname
StringuploadServerPwd
StringuploadServerType
StringuploadServerDir
StringrunFiles
runFile
String$class: 'WebLoadAnalyticsBuilder'inputLsFile
StringportfolioFile
Stringformat
JUNIT, HTML, DOC, ODT, XLS, XLSX, RTF, PDF, CSV, RAWlocation
StringreportName
StringcompareToSessions
StringcompareToPreviousBuilds
int$class: 'WebLoadConsoleBuilder'tplFile
StringlsFile
StringexecutionDuration
longvirtualClients
longprobindClient
long$class: 'WildflyBuilder'war
Stringhost
Stringport
Stringusername
Stringpassword
Stringserver
String$class: 'WinBatchBuildStep'buildStepId
StringscriptBuildStepArgs
defineArgs
booleanbuildStepArgs
arg
String$class: 'WinDocksBuilder'ipaddress
Stringimage
StringwinRMClienthostName
StringcredentialsId
StringwinRMOperations
invokeCommandcommand
StringsendFilesource
Stringdestination
StringconfigurationName
String$class: 'WixToolsetBuilder'sources
StringmarkAsUnstable
booleancompileOnly
booleanuseUiExt
booleanuseUtilExt
booleanuseBalExt
booleanuseComPlusExt
booleanuseDependencyExt
booleanuseDifxAppExt
booleanuseDirectXExt
booleanuseFirewallExt
booleanuseGamingExt
booleanuseIISExt
booleanuseMsmqExt
booleanuseNetfxExt
booleanusePsExt
booleanuseSqlExt
booleanuseTagExt
booleanuseVsExt
booleanmsiOutput
Enter a name for the generated MSI/EXE package. If left blank, the MSI package is named setup.msi. You can also use the file ending *.exe. But keep in mind, that you have to create a Bootstrapper and activeate the BalExtension to create an Executable.
You can use environment variables like $GIT_BRANCH to define a package name.
Stringarch
String$class: 'WorkspaceDeployment'apiKey
StringappName
StringglobIncludes
StringglobExcludes
StringprocfilePath
StringxcodeBuildallowFailingBuildResults (optional)
Checking this option will prevent a build step from failing if xcodebuild exits with a non-zero return code.
This can be useful for build steps that run unit tests and also have a post-build task to publish unit test results: the test step will not fail the entire build for a failing unit test, but will instead mark the build unstable in the "publish test" phase.
booleanappURL (optional)
StringassetPackManifestURL (optional)
StringassetPacksBaseURL (optional)
StringassetPacksInBundle (optional)
booleanbuildDir (optional)
The value to use for the BUILD_DIR setting. You only need to supply this value if you want the product of the Xcode build to be in a location other than the one specified in project settings and this job 'SYMROOT' parameter.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringbuildIpa (optional)
Checking this option will create a .ipa for each .app found in the build directory.
An .ipa is basically a zipped up .app.
This is quite handy for distributing ad-hoc builds to testers as they can just double-click the .ipa and it will import into iTunes.
booleanbundleID (optional)
The new bundle ID. Usually something like com.companyname.projectname.
StringbundleIDInfoPlistPath (optional)
The path to the info.plist file which contains the CFBundleIdentifier of your project.
Usually something like:
StringcfBundleShortVersionStringValue (optional)
This will set the CFBundleShortVersionString to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
StringcfBundleVersionValue (optional)
This will set the CFBundleVersion to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example the value ${BUILD_NUMBER} will be replaced with the current build number.
We advice you to generate a unique value for each build if you want for example deploy it into a private store.
In that case, for example, you can use : ${JOB_NAME}-${BUILD_NUMBER}
StringchangeBundleID (optional)
Checking this option will replace the bundle identifier.
You will need to specify which bundle ID (CFBundleIdentifier) to use and where is the Info.plist file located.
This is handy for example when you want to use a different code signing identity in your development projects.
booleancleanBeforeBuild (optional)
This will delete the build directories before invoking the build. This will force the rebuilding of ALL dependencies and can make large projects take a lot longer.
booleancleanResultBundlePath (optional)
This will delete the ResultBundlePath before invoking the build.
If the directory already exists in the location specified by ResultBundlePath, xcodebuild will be an error and should be checked.
booleancleanTestReports (optional)
booleancompileBitcode (optional)
booleanconfiguration (optional)
This is the name of the configuration as defined in the Xcode project.
By default there are Debug and Release configurations.
StringcopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringgenerateArchive (optional)
Checking this option will create an .xcarchive .app found in the build directory.
An .xcarchive is useful for submission to the app store or third party crash reporters.
You must specify a Scheme to perform an archive.
booleanignoreTestResults (optional)
booleaninterpretTargetAsRegEx (optional)
Build all entries listed under the "Targets:" section of the xcodebuild -list output that match the regexp.
booleanipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainName (optional)
The name of this configured keychain. Each job will specify a keychain configuration by the name.
StringkeychainPath (optional)
The path of the keychain to use to retrieve certificates to sign the package (default : ${HOME}/Library/Keychains/login.keychain).
StringkeychainPwd (optional)
The password of the keychain to use to retrieve certificates to sign the package.
hudson.util.Secret
logfileOutputDirectory (optional)
Specify the directory to output the log of xcodebuild.
If you leave it blank, it will be output to "project directory/builds/${BUILD_NUMBER}/log" with other logs.
If an output path is specified, it is output as a xcodebuild.log file in a relative directory under the "build output directory"
StringmanualSigning (optional)
booleannoConsoleLog (optional)
booleanprovideApplicationVersion (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresultBundlePath (optional)
Specify the directory to output the output the test result.
If you leave it blank, it will not output a test result and will not analyze the test results.
If an output path is specified, it is output as a test result in a relative directory under the "ResultBundlePath".
The plug-in analyzes the test result here and outputs a JUnit compatible XML file under the ${WORKSPACE}/test-reports.
Stringsdk (optional)
You only need to supply this value if you want to specify the SDK to build against. If empty, the SDK will be determined by Xcode. If you wish to run OCUnit tests, you will need to use the iPhone Simulator's SDK, for example:
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.1.sdk/
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
You only need to supply this value if you want to specify the SYMROOT path to use.
If empty, the default SYMROOT path will be used (it could be different depending of your Xcode version).
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/symroot
Stringtarget (optional)
The target to build. If left empty, this will build all targets in the project.
If you wish to build your binary and the unit test module, it is best to do this as two separate steps each with their own target.
This was, the iPhone Simulator SDK can be specified for the unit tests.
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanuseLegacyBuildSystem (optional)
Instead of "New Builld System" which became available from Xcode 9, we build the application using the legacy build system.
There is a possibility that you can handle old projects that cause problems with the new build system.
Also, since new output formats of logs are changed in the new build system, it is also useful when you want to handle logs with legacy third party tools.
booleanxcodeName (optional)
StringxcodeProjectFile (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringxcodebuildArguments (optional)
Extra xcodebuild parameters, added after the command that jenkins generates based on the rest of the config
String$class: 'XFramiumBuilder'configFile
StringsuiteName
StringtestNames
StringtagNames
StringstepTags
StringdeviceTags
StringdefaultCloud
StringoverrideDefaults
boolean$class: 'XLRVarSetterBuilder'XLR_releaseId
StringXLR_varName
StringJKS_varName
Stringdebug
booleanosfBuilderSuiteXMLLintxsdsPath (optional)
StringxmlsPath (optional)
StringreportPath (optional)
String$class: 'XShellBuilder'commandLine
StringexecuteFromWorkingDir
booleanregexToKill
StringtimeAllocated
String$class: 'XUnitBuilder'tools
AUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanBoostTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCheckpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'CpptestPluginType'pattern
StringfailIfNotNew
booleandeleteOutputFiles
booleanCustompattern
StringcustomXSL
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanembUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanFPCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleangtesterpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'GallioPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanGoogleTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'JSUnitPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanJUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMSTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMbUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit3pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit2pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanPHPUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftSOAtest9xType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanQtTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'SCTMTestType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanUnitTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanValgrindpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanxUnitDotNetpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'hudson.plugins.testcomplete.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
String$class: 'jenkins.plugins.xunit.tc11.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
Stringthresholds
failedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringpassedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringskippedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringthresholdMode
inttestTimeMargin
StringreduceLog (optional)
boolean$class: 'ZAPBuilder'startZAPFirst
booleanzapHost
StringzapPort
Stringzaproxy
autoInstall
booleantoolUsed
StringzapHome
Stringjdk
Stringtimeout
intzapSettingsDir
StringautoLoadSession
booleanloadSession
StringsessionFilename
StringremoveExternalSites
booleaninternalSites
StringcontextName
StringincludedURL
StringexcludedURL
StringalertFilters
StringauthMode
booleanusername
Stringpassword
StringloggedInIndicator
StringloggedOutIndicator
StringauthMethod
StringloginURL
StringusernameParameter
StringpasswordParameter
StringextraPostData
StringauthScript
StringauthScriptParams
scriptParameterName
StringscriptParameterValue
StringtargetURL
StringspiderScanURL
booleanspiderScanRecurse
booleanspiderScanSubtreeOnly
booleanspiderScanMaxChildrenToCrawl
intajaxSpiderURL
booleanajaxSpiderInScopeOnly
booleanactiveScanURL
booleanactiveScanRecurse
booleanactiveScanPolicy
StringgenerateReports
booleanselectedReportMethod
StringdeleteReports
booleanreportFilename
StringselectedReportFormats
StringselectedExportFormats
StringexportreportTitle
StringexportreportBy
StringexportreportFor
StringexportreportScanDate
StringexportreportReportDate
StringexportreportScanVersion
StringexportreportReportVersion
StringexportreportReportDescription
StringexportreportAlertHigh
booleanexportreportAlertMedium
booleanexportreportAlertLow
booleanexportreportAlertInformational
booleanexportreportCWEID
booleanexportreportWASCID
booleanexportreportDescription
booleanexportreportOtherInfo
booleanexportreportSolution
booleanexportreportReference
booleanexportreportRequestHeader
booleanexportreportResponseHeader
booleanexportreportRequestBody
booleanexportreportResponseBody
booleanjiraCreate
booleanjiraProjectKey
StringjiraAssignee
StringjiraAlertHigh
booleanjiraAlertMedium
booleanjiraAlertLow
booleanjiraFilterIssuesByResourceType
booleancmdLinesZAP
cmdLineOption
StringcmdLineValue
String$class: 'ZOSJobSubmitter'server
Stringport
intcredentialsId
Stringwait
booleanwaitTime
intdeleteJobFromSpool
booleanjobLogToConsole
booleanjobFile
StringMaxCC
StringJESINTERFACELEVEL1
boolean$class: 'ZanataCliBuilder'projFile
StringsyncG2zanata
booleansyncZ2git
booleanzanataCredentialsId
StringextraPathEntries (optional)
String$class: 'ZanataSyncStep'zanataCredentialsId
StringpullFromZanata (optional)
booleanpushToZanata (optional)
booleansyncOption (optional)
StringzanataLocaleIds (optional)
StringzanataProjectConfigs (optional)
StringzanataURL (optional)
String$class: 'ZapRunner'host
StringzapInstallDescription
value
Stringpath
StringrepositoryURL
StringsourcePath
StringzulipSendmessage (optional)
Stringstream (optional)
Stringtopic (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncApiToken (optional)
StringncProfileId (optional)
StringncServerURL (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.alauda.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.aliyun.www.cos.DeployBuilder'masterurl
StringappName (optional)
StringcomposeTemplate (optional)
StringcredentialsId (optional)
StringpublishStrategy (optional)
String$class: 'com.cloudbees.dockerpublish.DockerBuilder'repoName
StringbuildAdditionalArgs (optional)
StringbuildContext (optional)
StringcreateFingerprint (optional)
booleandockerToolName (optional)
StringdockerfilePath (optional)
StringforcePull (optional)
booleanforceTag (optional)
booleannoCache (optional)
booleanregistry (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringrepoTag (optional)
Stringserver (optional)
uri
unix:///var/run/docker.sock or
tcp://127.0.0.1:2376).
StringcredentialsId
StringskipBuild (optional)
booleanskipDecorate (optional)
booleanskipPush (optional)
booleanskipTagLatest (optional)
boolean$class: 'com.cloudbees.plugins.deployer.DeployBuilder'hosts
?>
$class: 'com.etas.jenkins.plugins.CreateTextFile.CreateFileBuilder'textFilePath
StringtextFileContent
StringfileOption
StringuseWorkspace
boolean$class: 'com.groupon.jenkinsci.plugins.DotCiFigtemplate.HelloWorldBuilder'name
StringNCScanBuilderncScanType
StringncWebsiteId
StringncApiToken (optional)
StringncProfileId (optional)
StringncServerURL (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.openshift.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.perfectomobile.jenkins.copyartifact.CopyArtifact'projectName
Stringparameters
Stringselector
$class: 'ParameterizedBuildSelector'parameterName
String$class: 'PermalinkBuildSelector'id
String$class: 'SavedBuildSelector'$class: 'SpecificBuildSelector'buildNumber
String$class: 'StatusBuildSelector'stableOnly
boolean$class: 'TriggeredBuildSelector'fallback
boolean$class: 'WorkspaceSelector'filter
Stringtarget
Stringflatten
booleanoptional
booleanfingerprintArtifacts
booleanautoMedia
String$class: 'com.quest.tdt.ScriptBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringscript
Stringfile
The full file path including name and extension of the SQL file to execute. Please note that this is relative to the machine running the job.
StringsourceType
StringoutputName
StringlimitMaxRows
StringmaxRows
The maximum number of returned rows if any rows are to be returned.
int$class: 'com.synopsys.integration.jenkins.coverity.extensions.buildstep.CoverityBuildStep'coverityInstanceUrl
Specify which Synopsys Coverity connect instance to run this job against.
The resulting Synopsys Coverity connect instance URL is stored in the $COV_URL environment variable, and will affect both the full and incremental analysis.
StringonCommandFailure
Specify the action to take if a Coverity static analysis command fails.
StringprojectName
Specify the name of the Coverity project.
The resulting project name is stored in the $COV_PROJECT environment variable, and will affect both the full and incremental analysis.
StringstreamName
Specify the name of the Coverity stream that you would like to use for the commands.
The resulting stream name is stored in the $COV_STREAM environment variable, and will affect both the full and incremental analysis.
StringcheckForIssuesInView
viewName
Specify the name of the Coverity view that you would like to check for issues.
The resulting view name is stored in the $COV_VIEW environment variable, and affects checking for issues in both the full and incremental analysis, if configured.
StringbuildStatusForIssues
Specify the build status to set if issues are found in the configured view.
StringconfigureChangeSetPatterns
changeSetExclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be excluded |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringchangeSetInclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly included from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be included |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringcoverityRunConfiguration
$class: 'AdvancedCoverityRunConfiguration'commands
command
Provide the Coverity command you want to run.
The command should start with the name of the Coverity command you want to run. Ex: cov-build, cov-analyze, etc.
For examples and a list of the available environment variables that can be used, refer to Command Examples
String$class: 'SimpleCoverityRunConfiguration'coverityAnalysisType
Specify the type of analysis you would like to run.
Full Analysis will run the cov-build, cov-analyze, and cov-commit-defects commands (in that order)
Incremental Analysis will run the cov-build, cov-run-desktop, and cov-commit-defects commands (in that order)
Specifically, the commands will be invoked with the following parameters:
| cov-build --dir ${WORKSPACE}/idir build command |
| cov-analyze --dir ${WORKSPACE}/idir |
| cov-run-desktop --dir ${WORKSPACE}/idir --url ${COV_URL} ${CHANGE_SET} |
| cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM} |
COV_ANALYZE, COV_RUN_DESKTOPbuildCommand
StringcommandArguments
covBuildArguments
Specify additional arguments to apply to the invocation of the cov-build command. Affects full and incremental analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
build command
StringcovAnalyzeArguments
Specify additional arguments to apply to the invocation of the cov-analyze command. Affects full analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
StringcovRunDesktopArguments
Specify additional arguments to apply to the invocation of the cov-run-desktop command. Affects incremental analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
--url ${COV_URL}
--stream ${COV_STREAM}
${CHANGE_SET}
StringcovCommitDefectsArguments
Specify additional arguments to apply to the invocation of the cov-commit-defects command. Affects both full and incremental analysis.
NOTE:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, configure the 'Run custom Coverity commands' section below.
--dir ${WORKSPACE}/idir
--url ${COV_URL}
--stream ${COVERITY_STREAM}
String$class: 'eggPlantBuilder'script
Relative to the Execution Directory, specify the script or scripts, separated by commas to execute in the test relative to the workspace directory for this job, for example:
NOTE: To have scripts run against different SUTs, it is necessary to create a build step for each SUT.
StringSUT
Stringport
Set the VNC Server port for the SUT, eg. 5900. Leaving this blank will use the default port for VNC, 5900.
Stringpassword
Specifies the password for the VNC server. If there's no password, this field can be left blank.
StringcolorDepth
StringglobalResultsFolder
OPTIONAL. Specify the path to the global results folder, relative to the workspace.
StringdefaultDocumentDirectory
Specify the path to the Default Document Directory, relative to the Execution Directory. See Running Eggplant From the Command Line in the Eggplant documentation
Stringparams
Parameters to be passed to the script(s). Equivalent to the -params flag when executing from the command line.
StringreportFailures
booleancommandLineOutput
Pipe eggPlant results out as part of the console output.
booleaninstallationName
StringcopyArtifactsprojectName
The name of the project to copy artifacts from.
Artifacts from all modules will be copied. Enter JOBNAME/MODULENAME here to copy from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins.
Example: MyMavenJob/my.group$MyModule
Artifacts from all configurations will be copied, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins.
Example: If the target directory is given as fromMatrix then the copy could create $WORKSPACE/fromMatrix/label=slaveA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=slaveB/dist/mybuild.jar.
To copy from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration.
Example: MyMatrixJob/jdk=Java6u17
To copy artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project.
Example: OtherMatrixJob/jdk=$jdk
Use a path consisting of the project name followed by the branch name.
Example: /MyMultibranchProject/MyBranch
Special letters like '/' in branch names should be escaped. You can see the exact name in "Full project name" in job pages of each branch.
Example: ../MyMultibranchProject/feature%2Fnavigation
See the wiki page "How to reference another project by name" for more information.
Stringexcludes (optional)
Stringfilter (optional)
StringfingerprintArtifacts (optional)
booleanflatten (optional)
booleanoptional (optional)
booleanparameters (optional)
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.
StringresultVariableSuffix (optional)
If not specified, the source project name will be used instead (in all uppercase, and sequences of characters other than A-Z replaced by a single underscore).
Example:
| Source project name | Suffix to be used |
|---|---|
| Project-ABC | PROJECT_ABC |
| tool1-release1.2 | TOOL_RELEASE_ |
Stringselector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacetarget (optional)
String$class: 'iOSAppInstaller'url
StringcloudTestServerID
Stringipa
StringadditionalOptions
String$class: 'iOSSimulatorLauncher'url
StringcloudTestServerID
Stringapp
Stringsdk
Stringfamily
String$class: 'jenkins.plugins.coverity.CoverityBuildStep'The build step can be configured as any other build steps. Choose the appropriate builder and configure the command to be performed. The configured build step will be wrapped with the Coverity cov-build executables so that it captures the build and can be used to further analysis by using coverity static tools. This build step is only for capturing build of compiled sources.
buildStep
$class: 'org.jenkinsci.plugins.dockerbuildstep.DockerBuilder'dockerCmd
$class: 'CommitCommand'containerId
Stringrepo
Stringtag
StringrunCmd
String$class: 'CreateContainerCommand'image
Stringcommand
StringhostName
StringcontainerName
StringenvVars
Stringlinks
StringexposedPorts
StringcpuShares
StringmemoryLimit
Stringdns
StringextraHosts
StringpublishAllPorts
This setting corresponds to the --publish-all (-P) option of the docker run CLI command.
booleanportBindings
--publish (
-p) option of the
docker run CLI command.
Enter one or more port binding, each on its own line. The syntax is host container where host is either hostPort or hostIp:hostPort and container is either containerPort or containerPort/protocol.
Alternatively, you can separate host and port with a colon (":"), thus using the same syntax as in the Docker CLI.
Examples
StringbindMounts
--volume (
-v) option of the
docker run CLI command.
Enter one or more bind mount, each on its own line. The syntax is hostPath containerPath[ rw|ro]
Stringprivileged
This setting corresponds to the --privileged option of the docker run CLI command.
booleanalwaysRestart
boolean$class: 'CreateImageCommand'dockerFolder
StringimageTag
StringdockerFile
StringnoCache
booleanrm
booleanbuildArgs
String$class: 'ExecCreateAndStartCommand'containerIds
Stringcommand
String$class: 'ExecCreateCommand'containerIds
Stringcommand
String$class: 'ExecStartCommand'commandIds
String$class: 'KillCommand'containerIds
String$class: 'PullImageCommand'fromImage
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'PushImageCommand'image
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'RemoveAllCommand'removeVolumes
booleanforce
boolean$class: 'RemoveCommand'containerIds
StringignoreIfNotFound
booleanremoveVolumes
booleanforce
boolean$class: 'RemoveImageCommand'imageName
StringimageId
StringignoreIfNotFound
boolean$class: 'RestartCommand'containerIds
Stringtimeout
int$class: 'SaveImageCommand'imageName
StringimageTag
Stringdestination
Stringfilename
StringignoreIfNotFound
boolean$class: 'StartByImageIdCommand'imageId
String$class: 'StartCommand'containerIds
StringwaitPorts
StringcontainerIdsLogging
String$class: 'StopAllCommand'$class: 'StopByImageIdCommand'imageId
String$class: 'StopCommand'containerIds
String$class: 'TagImageCommand'image
Stringrepository
Stringtag
StringignoreIfNotFound
booleanwithForce
boolean$class: 'org.jenkinsci.plugins.ios.connector.DeployBuilder'path
Stringudid
(We are looking for more ways to let you specify the target device flexibly. Please send in your suggestions.)
String$class: 'org.jenkinsci.plugins.lsf.BatchBuilder'job
StringfilesToDownload
StringdownloadDestination
StringfilesToSend
StringcheckFrequencyMinutes
intsendEmail
booleanosfBuilderSuiteForSFCCDeployhostname (optional)
StringbmCredentialsId (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringbuildVersion (optional)
StringcreateBuildInfoCartridge (optional)
booleanactivateBuild (optional)
booleansourcePaths (optional)
sourcePath
StringexcludePatterns
excludePattern
StringtempDirectory (optional)
Stringgreetname
StringuseFrench (optional)
boolean$class: 'org.jenkinsci.plugins.sge.BatchBuilder'job
StringfilesToDownload
StringdownloadDestination
StringfilesToSend
StringcheckFrequencyMinutes
floatsendEmail
boolean$class: 'org.jenkinsci.plugins.spoontrigger.ScriptBuilder'scriptFilePath
StringcredentialsId
StringhubUrl
StringimageName
StringvmVersion
StringcontainerWorkingDir
StringmountSettings
sourceContainer
StringsourceFolder
StringtargetFolder
StringrouteFile
StringnoBase
booleanoverwrite
booleandiagnostic
boolean$class: 'org.jenkinsci.plugins.trial_balloon.HelloWorldBuilder'name
String$class: 'org.quality.gates.jenkins.plugin.QGBuilder'jobConfigData
org.quality.gates.jenkins.plugin.JobConfigData
globalConfigDataForSonarInstance
org.quality.gates.jenkins.plugin.GlobalConfigDataForSonarInstance
$class: 'quality.gates.jenkins.plugin.QGBuilder'jobConfigData
quality.gates.jenkins.plugin.JobConfigData
$class: 'vRABlueprintBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringpackageBlueprint
booleanblueprintPath
StringoverWrite
booleanpublishBlueprint
booleanserviceCategory
String$class: 'vRADeploymentBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringblueprintName
StringwaitExec
booleanrequestTemplate
booleanrequestParams
json
StringbuildContent
String$class: 'BumblebeePublisher'configs
domain
StringprojectName
StringtestPlan
StringtestLab
StringtestSet
Stringformat
StringresultPattern
StringcustomProperties
StringfailIfUploadFailed
booleanoffline
booleanbyteguardGreettoken
Stringtask_id
StringcaapmpluginperformanceComparatorProperties
StringloadGeneratorStartTime
StringloadGeneratorEndTime
StringloadGeneratorName
StringgenerateCachecaches
type
A2L, ELF, BUS, MODEL, SERVICEfilePath
StringdbChannel
Stringclear
booleancastechoinstallationName
StringsourcePath
StringapplicationName
StringdisplayLog (optional)
booleanlogPath (optional)
StringoutputPath (optional)
StringqualityGate (optional)
String$class: 'CcmPublisher'canComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
Stringpattern (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
booleanchangeAsmVerversionPattern
StringassemblyCompany (optional)
StringassemblyCopyright (optional)
StringassemblyCulture (optional)
StringassemblyDescription (optional)
StringassemblyFile (optional)
StringassemblyProduct (optional)
StringassemblyTitle (optional)
StringassemblyTrademark (optional)
StringregexPattern (optional)
StringreplacementPattern (optional)
String$class: 'ChangesetEvaluator'basePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
StringdropAll (optional)
booleanlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringtagOnSuccessfulBuild (optional)
booleantestRollbacks (optional)
booleanurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
StringchatterPost postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId
If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
See Identity Confirmation in the salesforce.com online help for more information.
Stringbody
StringbuildUrlTitle (optional)
StringrecordId (optional)
Stringserver (optional)
StringcheckstylecanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
Stringpattern (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'ChefBuilderConfiguration'url
Stringsinatraurl
Stringfilter
Stringusername
Stringport
intcommand
Stringprivatekey
Stringparallel
booleanfail
booleanchlAtuoActioncontent
StringbrowserString
StringrunScriptOnly
booleanrootPath
StringlibPath
String$class: 'CifsPromotionPublisherPlugin'publishers
configName
Stringverbose
booleantransfers
sourceFiles
Stringexcludes
StringremoteDirectory
StringremovePrefix
StringremoteDirectorySDF
booleanflatten
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
booleanpatternSeparator
StringuseWorkspaceInPromotion
booleanusePromotionTimestamp
booleanretry
retries
intretryDelay
longlabel
label
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
StringcifsPublisheralwaysPublishFromMaster (optional)
booleancontinueOnError (optional)
booleanfailOnError (optional)
booleanmasterNodeName (optional)
StringparamPublish (optional)
$class: 'BapFtpParamPublish'parameterName
String$class: 'BapSshParamPublish'parameterName
Stringpublishers (optional)
configName
Stringverbose
booleantransfers
sourceFiles
Stringexcludes
StringremoteDirectory
StringremovePrefix
StringremoteDirectorySDF
booleanflatten
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
booleanpatternSeparator
StringuseWorkspaceInPromotion
booleanusePromotionTimestamp
booleanretry
retries
intretryDelay
longlabel
label
String$class: 'ClaimPublisher'googleStorageUploadcredentialsId
Stringbucket
Stringpattern
StringpathPrefix (optional)
StringsharedPublicly (optional)
booleanshowInline (optional)
booleanexamCleanTargetcleanupdeleteClient
boolean$class: 'CloudCoreoPublisher'blockOnHigh
booleanblockOnMedium
booleanblockOnLow
booleanpushToCloudFoundrytarget
Stringorganization
StringcloudSpace
StringcredentialsId
StringmanifestChoice (optional)
appName (optional)
StringappPath (optional)
Stringbuildpack (optional)
Stringcommand (optional)
Stringdomain (optional)
StringenvVars (optional)
key
Stringvalue
Stringhostname (optional)
Stringinstances (optional)
StringmanifestFile (optional)
Stringmemory (optional)
StringnoRoute (optional)
StringservicesNames (optional)
name
Stringstack (optional)
Stringtimeout (optional)
Stringvalue (optional)
StringpluginTimeout (optional)
StringselfSigned (optional)
StringservicesToCreate (optional)
name
Stringtype
Stringplan
StringresetService (optional)
boolean$class: 'CloverPublisher'cloverReportDir
StringcloverReportFileName
StringhealthyTarget
methodCoverage
intconditionalCoverage
intstatementCoverage
intunhealthyTarget
methodCoverage
intconditionalCoverage
intstatementCoverage
intfailingTarget
methodCoverage
intconditionalCoverage
intstatementCoverage
intcoberturaautoUpdateHealth (optional)
booleanautoUpdateStability (optional)
booleanclassCoverageTargets (optional)
StringcoberturaReportFile (optional)
StringconditionalCoverageTargets (optional)
StringenableNewApi (optional)
booleanfailNoReports (optional)
booleanfailUnhealthy (optional)
booleanfailUnstable (optional)
booleanfileCoverageTargets (optional)
StringlineCoverageTargets (optional)
StringmaxNumberOfBuilds (optional)
intmethodCoverageTargets (optional)
StringonlyStable (optional)
booleanpackageCoverageTargets (optional)
StringsourceEncoding (optional)
ASCII, Big5, Big5_HKSCS, Big5_Solaris, Cp037, Cp1006, Cp1025, Cp1026, Cp1046, Cp1047, Cp1097, Cp1098, Cp1112, Cp1122, Cp1123, Cp1124, Cp1140, Cp1141, Cp1142, Cp1143, Cp1144, Cp1145, Cp1146, Cp1147, Cp1148, Cp1149, Cp1250, Cp1251, Cp1252, Cp1253, Cp1254, Cp1255, Cp1256, Cp1257, Cp1258, Cp1381, Cp1383, Cp273, Cp277, Cp278, Cp280, Cp284, Cp285, Cp297, Cp33722, Cp420, Cp424, Cp437, Cp500, Cp737, Cp775, Cp838, Cp850, Cp852, Cp855, Cp856, Cp857, Cp858, Cp860, Cp861, Cp862, Cp863, Cp864, Cp865, Cp866, Cp868, Cp869, Cp870, Cp871, Cp874, Cp875, Cp918, Cp921, Cp922, Cp930, Cp933, Cp935, Cp937, Cp939, Cp942, Cp942C, Cp943, Cp943C, Cp948, Cp949, Cp949C, Cp950, Cp964, Cp970, EUC_CN, EUC_JP, EUC_JP_LINUX, EUC_JP_Solaris, EUC_KR, EUC_TW, GB18030, GBK, ISCII91, ISO2022_CN_CNS, ISO2022_CN_GB, ISO2022CN, ISO2022JP, ISO2022KR, ISO8859_1, ISO8859_13, ISO8859_15, ISO8859_2, ISO8859_3, ISO8859_4, ISO8859_5, ISO8859_6, ISO8859_7, ISO8859_8, ISO8859_9, JISAutoDetect, KOI8_R, MacArabic, MacCentralEurope, MacCroatian, MacCyrillic, MacDingbat, MacGreek, MacHebrew, MacIceland, MacRoman, MacRomania, MacSymbol, MacThai, MacTurkish, MacUkraine, MS874, MS932, MS936, MS949, MS950, MS950_HKSCS, PCK, SJIS, TIS620, UnicodeBig, UnicodeBigUnmarked, UnicodeLittle, UnicodeLittleUnmarked, UTF_16, UTF_8, x_iso_8859_11, x_JohabzoomCoverageChart (optional)
boolean$class: 'CodeAnalysisBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringobjects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringowner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringtype
StringobjectFolders
path
The path of the directory to use to analyse files. Please note that this is relative to the machine running the job.
Stringfilter
Stringrecurse
booleanreport
name
The base name of the reports, without an extension. If empty no reports will be generated.
Stringhtml
booleanjson
booleanxls
booleanxml
booleanruleSet
intfailConditions
halstead
Halstead level which will cause the code analysis to fail, exclude to ignore.
intmaintainability
Maintainability index level which will cause the code analysis to fail, exclude to ignore.
intmcCabe
McCabes level which will cause the code analysis to fail, exclude to ignore.
intTCR
Toad Code Rating level which will cause the code analysis to fail, exclude to ignore.
intruleViolations
If enabled, code analysis will fail on any violation for the selected rule set.
booleansyntaxErrors
If enabled, code analysis will fail on any syntax error.
booleanignoreWrappedPackages
If enabled, code analysis will fail when a wrapped package is found.
boolean$class: 'CodeBuilder'credentialsType
StringcredentialsId
StringproxyHost
StringproxyPort
StringawsAccessKey
StringawsSecretKey
hudson.util.Secret
awsSessionToken
Stringregion
StringprojectName
StringsourceVersion
StringsseAlgorithm
StringsourceControlType
StringlocalSourcePath
StringworkspaceSubdir
StringgitCloneDepthOverride
StringreportBuildStatusOverride
StringsecondarySourcesOverride
StringsecondarySourcesVersionOverride
StringartifactTypeOverride
StringartifactLocationOverride
StringartifactNameOverride
StringartifactNamespaceOverride
StringartifactPackagingOverride
StringartifactPathOverride
StringartifactEncryptionDisabledOverride
StringoverrideArtifactName
StringsecondaryArtifactsOverride
StringenvVariables
StringenvParameters
StringbuildSpecFile
StringbuildTimeoutOverride
StringsourceTypeOverride
StringsourceLocationOverride
StringenvironmentTypeOverride
StringimageOverride
StringcomputeTypeOverride
StringcacheTypeOverride
StringcacheLocationOverride
StringcloudWatchLogsStatusOverride
StringcloudWatchLogsGroupNameOverride
StringcloudWatchLogsStreamNameOverride
Strings3LogsStatusOverride
Strings3LogsLocationOverride
StringcertificateOverride
StringserviceRoleOverride
StringinsecureSslOverride
StringprivilegedModeOverride
StringcwlStreamingDisabled
StringexceptionFailureMode
String$class: 'CodeClimatePublisher'canComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
StringresultFile (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'CodeCoverageBuilder'connectionId
StringcredentialsId
StringanalysisPropertiesPath
StringanalysisProperties
String$class: 'CodeScanBuilder'projectKey
StringcommitOverride
Stringversion
StringemailReportTo
The list of user names in instance. Invalid usernames are skipped with a warning.
Setting the analysis mode to 'preview' will create a 'new issues' build report but will not update the database
StringanalysisMode
StringprojectBranch
Stringblocking
booleancodescenecredentialsId
StringdeltaAnalysisUrl
Stringrepository
StringanalyzeBranchDiff (optional)
booleananalyzeLatestIndividually (optional)
booleanbaseRevision (optional)
StringcouplingThresholdPercent (optional)
intfailOnDecliningCodeHealth (optional)
booleanfailOnFailedGoal (optional)
booleanletBuildPassOnFailedAnalysis (optional)
booleanmarkBuildAsUnstable (optional)
booleanriskThreshold (optional)
intuseBiomarkers (optional)
booleancodesonarconditions
warningCountIncreaseNewOnlyCondition will trigger the warranted result if the amount of warnings that did not exist until the current analysis is exceeded by more than the designated percentage.
Maximum percentage increase - if the percentage of warnings exceed this amount it will mark build with the desired result [default 5.0]
Mark build as - the desired result if the condition is triggered.
percentage (optional)
StringwarrantedResult (optional)
StringcyclomaticComplexityCondition will change the result of the build if the cyclomatic complexity of procedures exceeds the preset value.
Cyclomatic complexity limit - The procedures with cyclomatic complexity that exceeds this value will change the build result. [default 30]
Mark build as - the desired result if the condition is triggered.
maxCyclomaticComplexity (optional)
intwarrantedResult (optional)
StringredAlertsCondition will change the result of the build if the amount of red alerts exceed the predefined value.
Maximum amount of alerts - the maximum allowed amount of red alerts [default 1]
Mark build as - the desired result if the condition is triggered.
alertLimit (optional)
intwarrantedResult (optional)
StringwarningCountAbsoluteSpecifiedScoreAndHigherCondition will change the result of the build if the number of warnings above the predefined rank is greater then the maximum allowable.
Rank of warnings - only warnings that are at or above this rank will be checked. [default 56]
Maximum warnings - if the number of warnings at or above the specified score exceed this amount it will mark build with the desired result [default 20]
Mark build as - the desired result if the condition is triggered.
rankOfWarnings
intwarningCountThreshold
intwarrantedResult (optional)
StringwarningCountIncreaseOverallCondition will change the result of the build if the amount of warnings the analysis produces is greater than the preset percentage.
Maximum percentage increase - if the percentage of warnings exceed this amount it will mark build with the desired result [default 5.0]
Mark build as - the desired result if the condition is triggered.
percentage
StringwarrantedResult (optional)
StringwarningCountIncreaseSpecifiedScoreAndHigherCondition will change the result of the build if the percentage of warnings bellow the predefined rank increases above a certain percentage.
Rank of warnings - Only warnings that are bellow this rank will be checked. [default 30]
Maximum percentage increase - if the percentage of warnings exceed this amount it will mark build with the desired result [default 5.0]
Mark build as - the desired result if the condition is triggered.
rankOfWarnings
intwarningPercentage
StringwarrantedResult (optional)
StringyellowAlertsCondition will change the result of the build if the amount of yellow alerts exceed the predefined value.
Maximum amount of alerts - the maximum allowed amount of yellow alerts [default 1]
Mark build as - the desired result if the condition is triggered.
alertLimit (optional)
intwarrantedResult (optional)
Stringprotocol
StringhubAddress
StringprojectName
StringcredentialId
String$class: 'CodescannerPublisher'threshold
StringnewThreshold
StringfailureThreshold
StringnewFailureThreshold
Stringsourcecodedir
Stringexecutable
Stringhealthy (optional)
StringunHealthy (optional)
StringthresholdLimit (optional)
StringdefaultEncoding (optional)
StringuseDeltaValues (optional)
booleancanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleanfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
StringshouldDetectModules (optional)
booleanunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'CompareCoverageAction'jacocoCoverageCounter (optional)
StringpublishResultAs (optional)
StringscmVars (optional)
java.lang.String>
sonarLogin (optional)
StringsonarPassword (optional)
StringpublishConfluencesiteName
StringspaceName
StringpageName
StringattachArchivedArtifacts (optional)
booleanbuildIfUnstable (optional)
booleaneditorList (optional)
You can get links of uploaded attachments. Variable like $LINK[n] will be replaced with link which match link of uploaded attachment on Confluence.Where n is position number of attached file(links in array LINK[] will be provided in uploading order on Confluence). Example of usage:
<a href="$LINK[0]">$JOB_NAME build artifact</a>
confluenceAfterToken
Lorem ipsum
{jenkins-marker:after}
Ipsum lorem
Lorem ipsum
{jenkins-marker:after}
2011-06-19
Ipsum lorem
generator
confluenceFilefilename
StringconfluenceTexttext
StringmarkerToken
Enter the marker token where the content should be inserted. The replacement content will be inserted after this token.
The token should already exist in the configured Confluence page markup.
Example: "{jenkins-marker:build-urls}"
StringconfluenceAppendPagegenerator
confluenceFilefilename
StringconfluenceTexttext
StringconfluenceBeforeToken
Lorem ipsum
{jenkins-marker:before}
Ipsum lorem
Lorem ipsum
2011-06-19
{jenkins-marker:before}
Ipsum lorem
generator
confluenceFilefilename
StringconfluenceTexttext
StringmarkerToken
Enter the marker token where the content should be inserted. The replacement content will be inserted before this token.
The token should already exist in the configured Confluence page markup.
StringconfluenceBetweenTokens
Lorem ipsum
{jenkins-between:start|token=replaced-section}
previous content
{jenkins-between:end|token=replaced-section}
Ipsum lorem
Lorem ipsum
{jenkins-between:start|token=replaced-section}
2011-06-19
{jenkins-between:end|token=replaced-section}
Ipsum lorem
generator
confluenceFilefilename
StringconfluenceTexttext
StringstartMarkerToken
StringendMarkerToken
StringconfluenceWritePagegenerator
confluenceFilefilename
StringconfluenceTexttext
StringconfluencePrependPagegenerator
confluenceFilefilename
StringconfluenceTexttext
StringfileSet (optional)
Stringlabels (optional)
StringparentId (optional)
pageId=1234567)
If a parent is not specified, the space home will be used as the parent.
This field is used for creating new pages only. If the page already exists, then parentId is discarded.
longreplaceAttachments (optional)
booleanuploadToIncappticConnecttoken
Stringurl
StringappId
intmask
StringuseMasterProxy
booleanverboseLogging
boolean$class: 'ConsulKVBuilder'hostUrl
Stringkey
StringaclToken (optional)
StringapiUri (optional)
StringdebugMode (optional)
ENABLED, DISABLEDenvVarKey (optional)
StringignoreGlobalSettings (optional)
booleankeyValue (optional)
StringrequestMode (optional)
READ, WRITE, DELETEtimeoutConnection (optional)
inttimeoutResponse (optional)
intassessContainerImagefailOnPluginError (optional)
booleanimageId (optional)
StringnameRules (optional)
packageNameaction
Stringcontains
StringvulnerabilityCategoryaction
Stringcontains
StringvulnerabilityTitleaction
Stringcontains
StringvulnerablePackageNameaction
Stringcontains
StringthresholdRules (optional)
criticalVulnerabilitiesaction
Stringthreshold
StringcvssV2Scoreaction
Stringthreshold
StringexploitableVulnerabilitiesaction
Stringthreshold
StringvulnerabilitiesWithMalwareKitsaction
Stringthreshold
StringmoderateVulnerabilitiesaction
Stringthreshold
StringpackageRiskScoreaction
Stringthreshold
StringriskScoreaction
Stringthreshold
StringsevereVulnerabilitiesaction
Stringthreshold
StringtotalVulnerabilitiesaction
Stringthreshold
StringtreatWarningsAsErrors (optional)
booleanworkspaceDir (optional)
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
Stringconfigs
search
Stringreplace
StringmatchCount
int$class: 'ContinuousReleaseProperties'properties
java.lang.String>
copyArtifactsprojectName
The name of the project to copy artifacts from.
Artifacts from all modules will be copied. Enter JOBNAME/MODULENAME here to copy from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins.
Example: MyMavenJob/my.group$MyModule
Artifacts from all configurations will be copied, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins.
Example: If the target directory is given as fromMatrix then the copy could create $WORKSPACE/fromMatrix/label=slaveA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=slaveB/dist/mybuild.jar.
To copy from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration.
Example: MyMatrixJob/jdk=Java6u17
To copy artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project.
Example: OtherMatrixJob/jdk=$jdk
Use a path consisting of the project name followed by the branch name.
Example: /MyMultibranchProject/MyBranch
Special letters like '/' in branch names should be escaped. You can see the exact name in "Full project name" in job pages of each branch.
Example: ../MyMultibranchProject/feature%2Fnavigation
See the wiki page "How to reference another project by name" for more information.
Stringexcludes (optional)
Stringfilter (optional)
StringfingerprintArtifacts (optional)
booleanflatten (optional)
booleanoptional (optional)
booleanparameters (optional)
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.
StringresultVariableSuffix (optional)
If not specified, the source project name will be used instead (in all uppercase, and sequences of characters other than A-Z replaced by a single underscore).
Example:
| Source project name | Suffix to be used |
|---|---|
| Project-ABC | PROJECT_ABC |
| tool1-release1.2 | TOOL_RELEASE_ |
Stringselector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacetarget (optional)
StringcopydstFile (optional)
StringkeepMeta (optional)
booleanrecursive (optional)
booleansrcFile (optional)
String$class: 'CordellWalkerRecorder'publishCoverageadapters (optional)
antPathpath
StringcoberturaAdapterpath
Stringthresholds (optional)
thresholdTarget
StringfailUnhealthy (optional)
booleanunhealthyThreshold (optional)
floatunstableThreshold (optional)
floatistanbulCoberturaAdapterpath
Stringthresholds (optional)
thresholdTarget
StringfailUnhealthy (optional)
booleanunhealthyThreshold (optional)
floatunstableThreshold (optional)
floatjacocoAdapterpath
Stringthresholds (optional)
thresholdTarget
StringfailUnhealthy (optional)
booleanunhealthyThreshold (optional)
floatunstableThreshold (optional)
floatllvmAdapterpath
Stringthresholds (optional)
thresholdTarget
StringfailUnhealthy (optional)
booleanunhealthyThreshold (optional)
floatunstableThreshold (optional)
floatcalculateDiffForChangeRequests (optional)
booleanfailNoReports (optional)
booleanfailUnhealthy (optional)
booleanfailUnstable (optional)
booleanglobalThresholds (optional)
thresholdTarget
StringfailUnhealthy (optional)
booleanunhealthyThreshold (optional)
floatunstableThreshold (optional)
floatsourceFileResolver (optional)
level
NEVER_STORE, STORE_LAST_BUILD, STORE_ALL_BUILDtag (optional)
StringcoverityResultsThe Publish Coverity View Results step will retrieve issues from the configured Coverity Connect Instance, Project, and View. This step does not run any Coverity Analysis tools, it only retrieves the latest issues for the configured Project and View. It is recommended to run Coverity analyze and commit as prior step(s) in the pipeline to retrieve up to date results.
The Instance is configured in the Global Configuration, use the name of the instance or this step. The Project is the string name identifier of the Coverity Connect project. The View is the name or numeric ID of the view to retrieve issues from. Any filtering details for issue results this pipeline step will use can be configured in the Coverity Connect UI, it is recommended to use a custom "Issues: By Snapshot" view for this pipeline.
Note: if the are multiple streams in the project the view should be configured so the view filter uses only the stream for this pipeline. Additionally, it is recommended to filter the status value to not retrieve any Fixed or Dismissed issues.
connectInstance
StringconnectView
StringprojectId
The Coverity Connect Project to fetch issues from. Projects will be listed in the Coverity Connect UI under Configuration -> Projects & Streams or by using the top right search to view all projects. The plain text project name can be used here.
Note: by default all Streams within a project will be used, so the View specified in conjunction with this value can filter the stream appropriately.
StringabortPipeline (optional)
booleanfailPipeline (optional)
booleanunstable (optional)
booleanpublishCppcheckXSize (optional)
intYSize (optional)
intallowNoReport (optional)
booleandisplayAllErrors (optional)
booleandisplayErrorSeverity (optional)
booleandisplayNoCategorySeverity (optional)
booleandisplayPerformanceSeverity (optional)
booleandisplayPortabilitySeverity (optional)
booleandisplayStyleSeverity (optional)
booleandisplayWarningSeverity (optional)
booleanfailureThreshold (optional)
Stringhealthy (optional)
StringignoreBlankFiles (optional)
booleannewFailureThreshold (optional)
StringnewThreshold (optional)
StringnumBuildsInGraph (optional)
intpattern (optional)
Cppcheck must be executed to generate XML reports for this plugin to function. Fileset 'includes' setting specifies the generated Cppcheck XML report files, such as '**/cppcheck-result-*.xml'. Base directory of the fileset is relative to the workspace root directory.
If no value is set, then the default '**/cppcheck-result.xml' will be used. Be sure to never include any non-report files into this pattern.
The plugin is able to work with both XML formats produced by Cppcheck, but always prefer to use the newer version 2. Cppcheck doesn't report some issues with the legacy format.
StringseverityError (optional)
booleanseverityInformation (optional)
booleanseverityNoCategory (optional)
booleanseverityPerformance (optional)
booleanseverityPortability (optional)
booleanseverityStyle (optional)
booleanseverityWarning (optional)
booleanthreshold (optional)
StringunHealthy (optional)
String$class: 'CpptestPublisher'pattern
StringpluginName
Stringhealthy (optional)
StringunHealthy (optional)
StringthresholdLimit (optional)
StringdefaultEncoding (optional)
StringuseDeltaValues (optional)
booleanunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalNormal (optional)
StringunstableTotalLow (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewNormal (optional)
StringunstableNewLow (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalNormal (optional)
StringfailedTotalLow (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewNormal (optional)
StringfailedNewLow (optional)
StringcanRunOnFailed (optional)
booleanshouldDetectModules (optional)
booleancanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'CreatePackageBuilder'Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_PACKAGE_NUMBER environment variable.
The choice of using the build step or post build action to trigger a BuildMaster build will be largely dependent on how you import the build artifacts into BuildMaster:
If you have multiple Jenkins jobs all triggering a build for the same BuildMaster application check out the "Enable Deployable in BuildMaster" and "Copy Previous Build's Variables" options as a means to ensure that the new BuildMaster build picks up artifacts from only the Jenkins jobs that have build for its release.
applicationId (optional)
StringdeployToFirstStage (optional)
waitUntilDeploymentCompleted
booleanprintLogOnFailure (optional)
booleanenableReleaseDeployable (optional)
If the BuildMaster deployable that these artifacts are associated with are disabled by default for a release checking this option will enable the deployable for the release before triggering a build.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
deployableId
The id of the deployable to ensure is enabled in BuildMaster for the selected release. Defaults to the BUILDMASTER_DEPLOYABLE_ID variable populated by the "Select BuildMaster Application" action.
StringpackageNumber (optional)
The number that BuildMaster should use for the build. Defaults to the BUILDMASTER_PACKAGE_NUMBER variable populated by the "Select BuildMaster Application" action. Leave the field blank to have BuildMaster use it's own BuildNumber - the BUILDMASTER_PACKAGE_NUMBER will be set to the actual BuildMaster build number used in this instance.
If supplying a build number to BuildMaster and the build will fail with a BadRequest exception if an attempt is made to reuse a build number from a previous build. If this happens you will need to update the Jenkins build number to something greater than the latest BuildMaster build - there is a plugin to help with that: Next Build Number Plugin.
NOTE: to retain backwards compatibility BUILDMASTER_PACKAGE_NUMBER has not been updated to reflect the new naming standard from BuildMaster - this may change in a future release
StringpackageVariables (optional)
Set build level variables.
variables
Provide a list of variables to pass to BuildMaster.
StringpreserveVariables (optional)
If checked will gather the variables from the previous build and include them in the list of variables being passed in for this build, these will not override any variables being added in the Variables list below.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
booleanreleaseNumber (optional)
StringcreateTagnexusInstanceId
StringtagName
StringtagAttributesJson (optional)
StringtagAttributesPath (optional)
String$class: 'CriticalBlockEnd'Release all resources that Critical block start had allocated for this job.
$class: 'CriticalBlockStart'Delimite the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
cryptomovename
Stringtoken
StringcucumberPublishes Cucumber results
This plugin requires that you use cucumber library to generate a json report. The plugin uses the json report to produce html reports that are available from jenkins on the build page after a build has run.
import cucumber.junit.Cucumber;
import org.junit.runner.RunWith;
@RunWith(Cucumber.class)
@Cucumber.Options(format = {"pretty", "html:target/cucumber", "json:target/cucumber.json"})
public class MyTest {
}
fileIncludePattern
Filter for the files that should be processed. Leave empty to use default pattern **/*.json.
StringbuildStatus (optional)
Build result to which the build should be set when the report is marked as failed or unstable.
Stringclassifications (optional)
Configure additional information as key-value displayed on main page of the report.
Pairs key-value which are passed to the report to be displayed.
key
Name of the classification.
Stringvalue
Value of the classification. Hyperlink, HTML code and Jenkins variable can be used for values, check Token Macro Plugin for details.
StringclassificationsFilePattern (optional)
Filter for the properties files that should be processed as classifications. Leave empty to use default pattern **/*.properties.
StringexpandAllSteps (optional)
booleanfailedFeaturesNumber (optional)
Maximum number of failed features above which build result is triggered. Provide value -1 if the rule should be skipped.
intfailedFeaturesPercentage (optional)
Maximum percentage of failed features above which build result is changed.
doublefailedScenariosNumber (optional)
Maximum number of failed scenarios above which build result is triggered. Provide value -1 if the rule should be skipped.
intfailedScenariosPercentage (optional)
Maximum percentage of failed scenarios above which build result is changed.
doublefailedStepsNumber (optional)
Maximum number of failed steps above which build result is triggered. Provide value -1 if the rule should be skipped.
intfailedStepsPercentage (optional)
Maximum percentage of failed steps above which build result is changed.
doublefileExcludePattern (optional)
Filter for the files that should be excluded from the report.
StringjsonReportDirectory (optional)
Directory where the JSON cucumber reports are located. By default and for empty value whole workspace is scanned.
StringmergeFeaturesById (optional)
Merge features with different JSON files that have same ID so scenarios are be stored in single feature.
booleanpendingStepsNumber (optional)
Maximum number of pending steps above which build result is triggered. Provide value -1 if the rule should be skipped.
intpendingStepsPercentage (optional)
Maximum percentage of pending steps above which build result is changed.
doubleskipEmptyJSONFiles (optional)
Skip empty JSON reports. If this flag is not selected then report generation fails on empty file.
booleanskippedStepsNumber (optional)
Maximum number of skipped steps above which build result is triggered. Provide value -1 if the rule should be skipped.
intskippedStepsPercentage (optional)
Maximum percentage of skipped steps above which build result is changed.
doublesortingMethod (optional)
This section allows to configure what is default sorting method for features:
StringstopBuildOnFailedReport (optional)
The default behaviour is to carry on with the build even if the cucumber report contains failures. This option stops the build. Particularly useful when for example there is a need for all tests to pass before deploying to production. Note that this overrides the Build Status option, and it always marks the build as failed.
booleantrendsLimit (optional)
Number of historical reports that should be presented.
intundefinedStepsNumber (optional)
Maximum number of undefined steps above which build result is triggered. Provide value -1 if the rule should be skipped.
intundefinedStepsPercentage (optional)
Maximum percentage of undefined steps above which build result is changed.
double$class: 'CucumberTestReportPublisher'reportsDirectory
StringfileIncludePattern
StringfileExcludePattern
StringmarkAsUnstable
booleancopyHTMLInWorkspace
booleanignoreUndefinedSteps
booleancucumberTo use this feature, first set up your build to run tests, then specify the path to Cucumber JSON files in the Ant glob syntax, such as **/build/test-reports/*.json. Be sure not to include any non-report files into this pattern. You can specify only one file pattern.
Once there are a few builds running with test results, you should start seeing something like this.
testResults
StringignoreBadSteps (optional)
booleanpublishGherkinResults To use the feature, ensure that you have added a Publish JUnit test results post-build action to your build. Then, specify the path to the Cucumber report XML files in the Ant glob syntax.
You can specify multiple patterns by separating them with commas.
This path should only contain Cucumber report files. Note that no other test types will be reported from this job.
cucumberResultsGlob
StringlivingDocsGenerates BDD living documentation based on Cucumber tests results
This plugin expects Cucumber json output from your tests to generate the documentation of your project. The plugin uses the json report to produce html and pdf documentation that will be available after build execution.
To build the documentation from your tests results you need to use cucumber json formatter:
import cucumber.junit.Cucumber;
import org.junit.runner.RunWith;
@RunWith(Cucumber.class)
@Cucumber.Options(format = "json:target/cucumber.json")
public class CucumberTest {
}
Note that format option was replaced by plugin in newer cucumber versions.
If you face java.lang.ClassCircularityError: org/jruby/RubyClass you probably hit issue JENKINS-31019, to solve that need to upgrade your installation to v1.640 or newer.
Cucumber living documentation plugin is backed by Cukedoctor, a BDD living documentation tool which integrates Cucumber. and Asciidoctor
featuresDir (optional)
Stringformat (optional)
HTML, PDF, ALLtoc (optional)
RIGHT, LEFT, CENTERnumbered (optional)
booleansectAnchors (optional)
booleantitle (optional)
StringhideFeaturesSection (optional)
booleanhideSummary (optional)
booleanhideScenarioKeyword (optional)
booleanhideStepTime (optional)
booleanhideTags (optional)
boolean$class: 'CxScanBuilder'credentialsId
StringbuildStep
StringteamPath
StringsastEnabled
booleanexclusionsSetting
StringfailBuildOnNewResults
booleanfailBuildOnNewSeverity
StringosaArchiveIncludePatterns
StringosaInstallBeforeScan
booleanuseOwnServerCredentials (optional)
booleanserverUrl (optional)
Stringusername (optional)
Stringpassword (optional)
StringprojectName (optional)
StringprojectId (optional)
longgroupId (optional)
Stringpreset (optional)
StringjobStatusOnError (optional)
GLOBAL, FAILURE, UNSTABLEpresetSpecified (optional)
booleanexcludeFolders (optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
StringfilterPattern (optional)
Example: **/*.java, **/*.html, !**\test\**\XYZ*
Pattern Syntax
A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.separators at the beginning of the pattern and the string to match:
When a pattern starts with a File.separator, the string to match must also start with a File.separator. When a pattern does not start with a File.separator, the string to match may not start with a File.separator. When one of these rules is not obeyed, the string will not match.
When a name path segment is matched against a pattern path segment, the following special characters can be used:
'*' matches zero or more characters
'?' matches one character.
May reference build parameters like ${PARAM}.
Examples:
"**\*.class" matches all .class files/dirs in a directory tree.
"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test.
"**" matches everything in a directory tree.
"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
Stringincremental (optional)
booleanfullScansScheduled (optional)
booleanfullScanCycle (optional)
intsourceEncoding (optional)
Stringcomment (optional)
StringskipSCMTriggers (optional)
booleanwaitForResultsEnabled (optional)
booleanvulnerabilityThresholdEnabled (optional)
booleanhighThreshold (optional)
intmediumThreshold (optional)
intlowThreshold (optional)
intosaEnabled (optional)
booleanosaHighThreshold (optional)
intosaMediumThreshold (optional)
intosaLowThreshold (optional)
intgeneratePdfReport (optional)
booleanenableProjectPolicyEnforcement (optional)
booleanthresholdSettings (optional)
StringvulnerabilityThresholdResult (optional)
StringincludeOpenSourceFolders (optional)
Include/Exclude definition will not affect dependencies resolved from package manager manifest files.
Comma separated list of include or exclude wildcard patterns. Exclude patterns start with exclamation mark "!". Example: *.jar */folder/* */folder1/folder2/* */folder*/* */file.* */file*.jar */test/*file*.*
May reference build parameters like ${PARAM}.
Examples:
"**/*.jar" matches all .jar jars in a directory tree.
"*/test/a??.jar" matches all files/dirs which start with an 'a', then two more characters and then ".jar", in a directory called test.
"**" matches everything in a directory tree.
"**/test/**/XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc/test/def/ghi/XYZ123").
StringexcludeOpenSourceFolders (optional)
StringavoidDuplicateProjectScans (optional)
booleangenerateXmlReport (optional)
booleanthisBuildIncremental (optional)
booleanosfBuilderSuiteForSFCCDataImporthostname (optional)
StringbmCredentialsId (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringarchiveName (optional)
StringsourcePath (optional)
StringincludePatterns (optional)
includePattern
StringexcludePatterns (optional)
excludePattern
StringimportStrategy (optional)
StringtempDirectory (optional)
String$class: 'DatabaseDocBuilder'outputDirectory (optional)
StringbasePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
Stringurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
StringdebianPbuilderadditionalBuildResults (optional)
When running a build in the chroot environment, there are occasionally files that you must retrieve from the chroot that are not part of the normal build. For example, some files that you may need to get back would include test results, auto-generated files, etc.
Set this variable in order to get the files back from the chroot build environment.
The files that are retrieved will also automatically be archived as well with the other build results.
This must be a comma-separated list; spaces are allowed.
Stringarchitecture (optional)
The architecture to build this as.
If the project is using the Matrix Build plugin, leave this blank (the architectures to build for are defined by the 'architecture' environment variable).
This is mostly to support Pipeline, however it can be used as a normal parameter as well.
StringbuildAsTag (optional)
Set this to mark this as building a tag. When a build comes from a tag, the deb version does not get incremented(i.e. it is exactly as set in the debian/changelog file). If using SVN, this plugin automatically looks at the SVN_URL_1 environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. If using Git, this plugin automatically looks at the GIT_BRANCH environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. Alternatively, you can also set the environment variable DEB_PBUILDER_BUILDING_TAG to either true or false.
booleancomponents (optional)
The components to build with. By default, pbuilder sets this to 'main'. If you're building an Ubuntu package, you may need to set this to "main restricted universe multiverse"
The setting guessComponents must be false for this setting to be honored.
StringdebianDirLocation (optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
Stringdistribution (optional)
The distribution to build for. By default, this checks the distribution that is set in debian/changelog. If the version in the changelog is UNRELEASED, it attempts to use the currently running distribution if this parameter is NULL or a 0-length string.
StringguessComponents (optional)
If set to true, automatically try to guess the components. This means that if we think we are building an Ubuntu package on Debian, our components will be automatically set to "main restricted universe multiverse"
booleankeyring (optional)
The keyring to build with. By default, we will attempt to figure out if we are building a Debian package on Ubuntu, and if we think that we are this will be set to /usr/share/keyrings/debian-archive-keyring.gpg. This file is part of the debian-archive-keyring package. If you need to use a custom keyring, put it in here. If for some reason the auto-detection is not working properly, set this to the string 'disabled' and no keyring settings for pbuilder will be set.
StringmirrorSite (optional)
The mirror site to use. If this is not set or a 0-length string, then the default mirror site for this distribution will be used. The default mirror site is defined in /etc/pbuilderrc
StringnumberCores (optional)
The number of cores to use when building. By default, this is 1. Set to -1 in order to use as many cores as possible when building. In order for this to take effect, you need to make sure that your debian/rules is setup properly. See this post.
intpristineTarName (optional)
If this field set, and if source/format indicates that this is a quilt package, we will attempt to checkout the given original tar file.
String$class: 'DeleteChartBuildStep'id
StringkubeName
Stringnamespace
StringchartsRepo
StringchartName
StringdeleteComponentsnexusInstanceId
StringtagName
String$class: 'DeleteSnapshot'vm
StringsnapshotName
Stringconsolidate
booleanfailOnNoExist
booleandependencyCheckPublisherfailedNewCritical (optional)
intfailedNewHigh (optional)
intfailedNewLow (optional)
intfailedNewMedium (optional)
intfailedTotalCritical (optional)
intfailedTotalHigh (optional)
intfailedTotalLow (optional)
intfailedTotalMedium (optional)
intnewThresholdAnalysisExploitable (optional)
booleanpattern (optional)
StringtotalThresholdAnalysisExploitable (optional)
booleanunstableNewCritical (optional)
intunstableNewHigh (optional)
intunstableNewLow (optional)
intunstableNewMedium (optional)
intunstableTotalCritical (optional)
intunstableTotalHigh (optional)
intunstableTotalLow (optional)
intunstableTotalMedium (optional)
intdependencyCheckadditionalArguments (optional)
StringodcInstallation (optional)
StringskipOnScmChange (optional)
booleanskipOnUpstreamChange (optional)
booleandependencyTrackPublisherartifact
StringartifactType
Stringsynchronous
booleanfailedNewCritical (optional)
intfailedNewHigh (optional)
intfailedNewLow (optional)
intfailedNewMedium (optional)
intfailedTotalCritical (optional)
intfailedTotalHigh (optional)
intfailedTotalLow (optional)
intfailedTotalMedium (optional)
intnewThresholdAnalysisExploitable (optional)
booleanprojectId (optional)
StringprojectName (optional)
StringprojectVersion (optional)
StringtotalThresholdAnalysisExploitable (optional)
booleanunstableNewCritical (optional)
intunstableNewHigh (optional)
intunstableNewLow (optional)
intunstableNewMedium (optional)
intunstableTotalCritical (optional)
intunstableTotalHigh (optional)
intunstableTotalLow (optional)
intunstableTotalMedium (optional)
int$class: 'Deploy'template
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringcustomizationSpec
StringtimeoutInSeconds
intpowerOn
booleansamDeploysettings
credentialsId
Stringregion
Strings3Bucket
StringstackName
StringtemplateFile
template.yaml
app/template.json
StringkmsKeyId (optional)
StringoutputTemplateFile (optional)
template-#jobId.yaml by default.
Stringparameters (optional)
key
Stringvalue
StringroleArn (optional)
Strings3Prefix (optional)
Stringtags (optional)
key
Stringvalue
String$class: 'DeployChartBuildStep'id
StringkubeName
Stringnamespace
StringchartsRepo
StringchartName
StringdeleteChartWhenFinished
booleancrxDeploypackageIdFilters (optional)
**/*.zip
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zip
Matching packages will be uploaded in the order in which the filters are specified. Only the highest matching version of a package identified by 'group:name' will be deployed, and it will only be deployed once per build step, regardless of the number of matching filters.
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringacHandling (optional)
Stringautosave (optional)
intbehavior (optional)
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringdisableForJobTesting (optional)
booleanlocalDirectory (optional)
Stringrecursive (optional)
booleanreplicate (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longbuildMasterDeployPackageToStageDeploys (or re-deploys) a build to a particular stage.
Note that when used in a pipeline step that the applicationdId, releaseNumber, and packageNumber fields are required:
buildMasterDeployPackageToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, packageNumber: BUILDMASTER_PACKAGE_NUMBER, waitTillBuildCompleted: [printLogOnFailure: true])
applicationId (optional)
This setting would only be altered if not using the "Select BuildMaster Application" action.
StringdeployVariables (optional)
Set deployment level variables.
variables
Provide a list of variables to pass to BuildMaster.
StringpackageNumber (optional)
The job will fail if there is no active BuildMaster release.
This setting would only be altered if not using the "Select BuildMaster Application" action.
StringprintLogOnFailure (optional)
booleanreleaseNumber (optional)
Stringstage (optional)
Optional. If not supplied, the next stage in the pipeline will be used.
StringwaitUntilDeploymentCompleted (optional)
booleansynopsys_detectdetectProperties
The command line options to pass to Synopsys Detect
StringdevSpacesCreateazureCredentialsId
StringaksName (optional)
StringkubeconfigId (optional)
StringresourceGroupName (optional)
StringsharedSpaceName (optional)
StringspaceName (optional)
StringdevSpacesCleanupazureCredentialsId
StringaksName (optional)
StringdevSpaceName (optional)
StringhelmReleaseName (optional)
StringhelmTillerNamespace (optional)
Namespace of Tiller. Will use the default namespace "azds" of Azure Dev Spaces if this field is left blank.
StringhelmTimeout (optional)
intkubeConfigId (optional)
StringresourceGroupName (optional)
StringsvDeployTestDeploys and starts CA DevTest test or test suite provided as a .mar file.
Throws exception if .mar file is incorrect, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringmarFilePath
StringtestType
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvDeployVirtualServiceDeploys and starts virtual service provided as a .mar file to target VSE. More services could be provided using comma or newline separator.
Throws exception if .mar file is incorrect, virtual service is already deployed, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringmarFilesPaths
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvStartVirtualServiceStarts virtual service that is already deployed on target VSE. More services could be started using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvStopVirtualServiceStops virtual service that is running on target VSE. More services could be stopped using comma or newline separator.
Throws exception if virtual service is not running on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleansvPublishTestReportGenerates simple test or test suite report that is available as a part of project run.
svUndeployVirtualServiceUndeploys (removes) virtual service from specified VSE. More services could be provided using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established
useCustomRegistry
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
Stringsecured
booleanimportDeveloperProfileprofileId
StringdeveloperProfileId (optional)
StringimportIntoExistingKeychain (optional)
booleankeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
hudson.util.Secret
$class: 'DiawiUploader'token
StringfileName
StringproxyHost
StringproxyPort
intproxyProtocol
StringdingTalkaccessToken (optional)
StringnotifyPeople (optional)
Stringmessage (optional)
StringimageUrl (optional)
StringjenkinsUrl (optional)
StringdingdingaccessToken
StringjsonFilePath
String$class: 'DockerBuilderControl'option
$class: 'DockerBuilderControlOptionProvisionAndStart'cloudName
StringtemplateId
String$class: 'DockerBuilderControlOptionRun'cloudName
Stringimage
StringpullCredentialsId
StringdnsString
Stringnetwork
StringdockerCommand
StringvolumesString
StringvolumesFrom
StringenvironmentsString
Stringhostname
StringmemoryLimit
intmemorySwap
intcpuShares
intshmSize
intbindPorts
StringbindAllPorts
booleanprivileged
booleantty
booleanmacAddress
String$class: 'DockerBuilderControlOptionStart'cloudName
StringcontainerId
String$class: 'DockerBuilderControlOptionStop'cloudName
StringcontainerId
Stringremove
boolean$class: 'DockerBuilderControlOptionStopAll'remove
boolean$class: 'DockerBuilderPublisher'dockerFileDirectory
StringfromRegistry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringcloud
StringtagsString
StringpushOnSuccess
booleanpushCredentialsId
StringcleanImages
booleancleanupWithJenkinsJobDelete
boolean$class: 'DockerComposeBuilder'useCustomDockerComposeFile
booleandockerComposeFile
Stringoption
$class: 'ExecuteCommandInsideContainer'privilegedMode
booleanservice
Stringcommand
Stringindex
intworkDir
String$class: 'StartAllServices'$class: 'StartService'service
Stringscale
int$class: 'StopAllServices'$class: 'StopService'service
StringdockerShellconnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intcontainerLifecycle (optional)
createContainer (optional)
bindAllPorts (optional)
booleanbindPorts (optional)
Stringcommand (optional)
StringcpuShares (optional)
intcpusetCpus (optional)
StringcpusetMems (optional)
StringdevicesString (optional)
StringdnsString (optional)
StringdockerLabelsString (optional)
Stringentrypoint (optional)
StringenvironmentString (optional)
StringextraHostsString (optional)
Stringhostname (optional)
StringlinksString (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
longnetworkMode (optional)
Stringprivileged (optional)
booleanrestartPolicy (optional)
policyName
NO, UNLESS_STOPPED, ALWAYS, ON_FAILUREmaximumRetryCount
intshmSize (optional)
longtty (optional)
booleanuser (optional)
StringvolumesFromString (optional)
StringvolumesString (optional)
Stringworkdir (optional)
Stringimage (optional)
StringpullImage (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intcredentialsId (optional)
StringpullStrategy (optional)
PULL_ALWAYS, PULL_ONCE, PULL_LATEST, PULL_NEVERregistriesCreds (optional)
registryAddr
StringcredentialsId
StringremoveContainer (optional)
force (optional)
booleanremoveVolumes (optional)
booleanstopContainer (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
inttimeout (optional)
intexecutorScript (optional)
StringlongConnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTYcredentialsId (optional)
StringreadTimeout (optional)
intshellScript (optional)
StringdownstreamPublisherworkspace
Stringpublishers (optional)
publishATXPublishes the ATX reports of all configured ECU-TEST packages or projects in this job.
These ATX reports are generated automatically in this post-build step and uploaded to TEST-GUIDE.
publishATX(String atxName, boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
publishATX(ATXInstallation installation, boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ATXServer.publish(boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
publishATX('TEST-GUIDE', false, false, true, true)
def server = ATX.server('TEST-GUIDE')
publishATX atxInstallation: server.installation
def server = ATX.newServer('TEST-GUIDE', 'ECU-TEST')
atx.publish()
atxName
StringallowMissing (optional)
booleanarchiving (optional)
booleanatxInstallation (optional)
name
StringtoolName
Stringconfig
settings
atxBooleanSettingname
Stringgroup
UPLOAD, ARCHIVE, ATTRIBUTE, TBC_CONSTANTS, TCF_CONSTANTS, SPECIALvalue
booleanatxTextSettingname
Stringgroup
UPLOAD, ARCHIVE, ATTRIBUTE, TBC_CONSTANTS, TCF_CONSTANTS, SPECIALvalue
StringcustomSettings
atxCustomBooleanSettingname
Stringchecked
booleanatxCustomTextSettingname
Stringvalue
StringkeepAll (optional)
booleanrunOnFailed (optional)
booleanpublishETLogsallowMissing (optional)
booleanarchiving (optional)
booleanfailedOnError (optional)
booleankeepAll (optional)
booleanrunOnFailed (optional)
booleantestSpecific (optional)
booleanunstableOnWarning (optional)
booleanpublishUNITPublishes the UNIT reports of all configured ECU-TEST packages or projects in this job.
These UNIT reports are generated automatically in this post-build step.
publishUNIT(String toolName, double unstableThreshold, double failedThreshold) : void
publishUNIT(ETInstallation installation, double unstableThreshold, double failedThreshold, boolean archiving, boolean keepAll) : void
ETInstance.publishUNIT(double unstableThreshold, double failedThreshold, boolean archiving, boolean keepAll) : void
publishUNIT('ECU-TEST', 10, 20)
def instance = ET.installation('ECU-TEST')
publishUNIT installation: instance.installation, unstableThreshold: 10, failedThreshold: 20
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishUNIT()
toolName
StringallowMissing (optional)
booleanarchiving (optional)
booleanfailedThreshold (optional)
doubleinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanrunOnFailed (optional)
booleanunstableThreshold (optional)
doublepublishGeneratorsPublishes and generates reports by configuration of predefined and/or custom report generators.
These reports will be generated for all configured ECU-TEST packages or projects in this job.
publishGenerators(String toolName, List<ReportGeneratorConfig> generators, List<ReportGeneratorConfig> customGenerators) : void
publishGenerators(ETInstallation installation, List<ReportGeneratorConfig> generators, List<ReportGeneratorConfig> customGenerators,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ETInstance.publishGenerators(List<ReportGeneratorConfig> generators, List<ReportGeneratorConfig> customGenerators,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
publishGenerators toolName: 'ECU-TEST', generators: [[name: 'JSON']]
def instance = ET.installation('ECU-TEST')
publishGenerators installation: instance.installation, generators: [[name: 'JSON']]
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishGenerators([[name: 'JSON']], [name: 'Custom-JSON')])
toolName
StringallowMissing (optional)
booleanarchiving (optional)
booleancustomGenerators (optional)
name
Stringsettings
name
Stringvalue
StringusePersistedSettings
booleangenerators (optional)
name
Stringsettings
name
Stringvalue
StringusePersistedSettings
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanrunOnFailed (optional)
booleanpublishTMSPublishes the test results of all configured ECU-TEST packages or projects in this job to a preconfigured test management system like RQM or ALM.
Pipeline usage
publishTMS(String toolName, String credentialsId, int timeout) : void
publishTMS(ETInstallation installation, String credentialsId, int timeout,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ETInstance.publishTMS(String credentialsId, int timeout) : void
publishTMS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
publishTMS installation: instance.installation, credentialsId: 'id', timeout: 120
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishTMS('id')
toolName
StringcredentialsId
StringallowMissing (optional)
booleanarchiving (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanrunOnFailed (optional)
booleantimeout (optional)
StringpublishTRFallowMissing (optional)
booleanarchiving (optional)
booleankeepAll (optional)
booleanrunOnFailed (optional)
booleanpublishTraceAnalysisPublishes the results of the trace analysis of all configured ECU-TEST packages or projects in this job.
Pipeline usage
publishTraceAnalysis(String toolName, boolean mergeReports, boolean createReportDir, int timeout) : void
publishTraceAnalysis(ETInstallation installation, boolean mergeReports, boolean createReportDir, int timeout,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ETInstance.publishTraceAnalysis(boolean mergeReports, boolean createReportDir, int timeout) : void
publishTraceAnalysis('ECU-TEST')
def instance = ET.installation('ECU-TEST')
publishTraceAnalysis installation: instance.installation, mergeReports: true, createReportDir: false
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishTraceAnalysis()
toolName
StringallowMissing (optional)
booleanarchiving (optional)
booleancreateReportDir (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanmergeReports (optional)
booleanrunOnFailed (optional)
booleantimeout (optional)
StringdownloadProgetPackageDownload options are:
See Inedo documentation.
feedName
StringgroupName
StringpackageName
Stringversion
StringdownloadFormat
StringdownloadFolder
If a full pathname is not supplied then the downloaded package 'should' end up in the workspace, but this is not guaranteed. If you wish the package to be placed in the workspace the it is best to use the Jenkins variable ${WORKSPACE}
StringcrxDownloadpackageIds (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanlocalDirectory (optional)
Stringrebuild (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longgoogleStorageDownloadcredentialsId
StringbucketUri
This specifies the cloud object to download from Cloud Storage. You can view these by visiting the "Cloud Storage" section of the Cloud Console for your project.
A single asterisk can be specified in the object path (not the bucket name), past the last "/". The asterisk behaves consistently with gsutil. For example, gs://my-bucket-name/pre/a_*.txt would match the objects in cloud bucket my-bucket-name that are named pre/a_2.txt or pre/a_abc23-4.txt, but not pre/a_2/log.txt.
StringlocalDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
StringpathPrefix (optional)
The specified prefix will be stripped from all downloaded filenames. Filenames that do not start with this prefix will not be modified. If this prefix does not have a trailing slash, it will be added automatically.
StringpdroneserverUrl
Stringchannel
StringcredentialsId
Stringartifacts
StringallowEmptyArchive (optional)
booleandefaultExcludes (optional)
This option allows to enable or disable the default Ant exclusions.
booleandeployKey (optional)
Stringexcludes (optional)
StringfailsAsUpload (optional)
booleanstripPath (optional)
foo/bar/file will get uploaded as
file instead.
booleanuploadV3 (optional)
boolean$class: 'DropboxPublisherPlugin'publishers
configName
Select an Dropbox account from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the Dropbox publication.
Stringverbose
booleantransfers
sourceFiles
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
Stringexcludes
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
StringremoteDirectory
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
StringremovePrefix
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
StringremoteDirectorySDF
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
| Remote directory | Directories created |
|---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
booleanflatten
Only create files on the server, don't create directories (except for the remote directory, if present)
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
booleancleanRemote
Select to delete all files and directories within the remote directory before transferring files.
booleanpruneRoot
A date format directory format can lead to a long list of directories. Removing old directories in the remote root will allow you to prune that list.
Directories older then the max days will be deleted.
booleanpruneRootDays
intuseWorkspaceInPromotion
Set the root directory for the Source files to the workspace
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
booleanusePromotionTimestamp
Use the build time of the promotion when the remote directory is a date format
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
booleandropboxRetry
If publishing to this server fails, try again.
Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
retries
intretryDelay
longdropboxLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
Select to publish from the Jenkins master.
The default is to publish from the server that holds the files to transfer (workspace on the slave, or artifacts directory on the master)
Enabling this option could help dealing with strict network configurations and firewall rules.
This option will cause the files to be transferred through the master before being sent to the remote server, this may increase network traffic, and could increase the build time.
booleanmasterNodeName
Set the NODE_NAME for the master Jenkins.
Set this option to give a value to the NODE_NAME environment variable when the value is missing (the Jenkins master).
This is useful if you use the $NODE_NAME variable in the remoteDirectory option and the build may occur on the master.
StringdrycanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
StringhighThreshold (optional)
intnormalThreshold (optional)
intpattern (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'ECXCDMBuilder'name
Stringpassword
Stringurl
Stringjob
Stringproduction
booleanmaxWaitTime
intpublishETLogsallowMissing (optional)
booleanarchiving (optional)
booleanfailedOnError (optional)
booleankeepAll (optional)
booleanrunOnFailed (optional)
booleantestSpecific (optional)
booleanunstableOnWarning (optional)
booleanazureIoTEdgeBuildazureCredentialsId (optional)
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringresourceGroup (optional)
StringrootPath (optional)
StringazureIoTEdgeDeployazureCredentialsId (optional)
StringresourceGroup (optional)
StringrootPath (optional)
In some cases, the Edge solution is not under the root of the code repository. You can specify path to the root of Edge solution in build definition. Example: If your code repository is an Edge solution, then leave it to default value './'. If your solution is under subfolder 'edge', then set it to 'edge'" Please notice that the module.json file path is relative to the root path of solution.
StringdeploymentFilePath (optional)
StringdeploymentId (optional)
Input the IoT Edge Deployment ID, if ID exists, it will be overridden.Lowercase letters, numbers and the following characters are allowed [ -:+%_#*?!(),=@;' ], no more than 128 characters. For more information: Visit docs
StringdeploymentType (optional)
StringdeviceId (optional)
StringiothubName (optional)
Stringpriority (optional)
Set the priority to a positive integer to resolve deployment conflicts: when targeted by multiple deployments a device will use the one with highest priority or (in case of two deployments with the same priority) latest creation time. For more information: Visit docs
StringtargetCondition (optional)
A target condition to determine which devices will be targeted with this deployment. Example tags.environment='test', properties.reported.devicemodel='4000x'
StringazureIoTEdgeGenConfigazureCredentialsId (optional)
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentFilePath (optional)
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringresourceGroup (optional)
StringrootPath (optional)
StringazureIoTEdgePushazureCredentialsId (optional)
StringresourceGroup (optional)
StringacrName (optional)
StringbypassModules (optional)
List of modules to bypass when building.
You can leave this field empty to build all modules
Or use comma delimited list of modules. Example "ModuleA,ModuleB"
StringdefaultPlatform (optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
StringdeploymentManifestFilePath (optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
StringdockerRegistryEndpoint (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdockerRegistryType (optional)
StringrootPath (optional)
String$class: 'ElasticsearchQueryBuilder'query
StringaboveOrBelow
Stringthreshold
longsince
longunits
String$class: 'ElectricFlowDeployApplication'applicationName (optional)
StringapplicationProcessName (optional)
Stringconfiguration (optional)
StringdeployParameters (optional)
StringenvironmentName (optional)
StringprojectName (optional)
StringvalidationTrigger (optional)
String$class: 'ElectricFlowGenericRestApi'parameters (optional)
key
Stringvalue
Stringbody (optional)
Stringconfiguration (optional)
StringhttpMethod (optional)
StringurlPath (optional)
String$class: 'ElectricFlowPipelinePublisher'addParam (optional)
StringadditionalOption (optional)
net.sf.json.JSONArray
configuration (optional)
StringpipelineName (optional)
StringprojectName (optional)
String$class: 'ElectricFlowRunProcedure'configuration (optional)
StringprocedureName (optional)
StringprocedureParameters (optional)
StringprojectName (optional)
String$class: 'ElectricFlowTriggerRelease'configuration (optional)
Stringparameters (optional)
StringprojectName (optional)
StringreleaseName (optional)
StringstartingStage (optional)
StringvalidationTrigger (optional)
String$class: 'EvaluateGate'policyName
StringtoolchainName
StringbuildJobName
StringcredentialsId
StringwillDisrupt
booleanscope
value
StringbranchName
StringenvName
StringadditionalBuildInfo
buildNumber
StringbuildUrl
StringapplicationName (optional)
StringexamTest_ExecutionFileexamName
StringpythonName
StringexamReport
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringpathExecutionFile (optional)
StringpathPCode (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleanexamTest_ModelexamName
StringpythonName
StringexamReport
StringexecutionFile (optional)
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanexamModel (optional)
StringjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringmodelConfiguration (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleanexecuteCerberusCampaigncampaignName
Stringenvironment
Stringbrowser
Stringscreenshot
Stringverbose
StringpageSource
StringseleniumLog
StringtimeOut
Stringretries
Stringpriority
Stringtag
Stringss_p
StringssIp
Stringrobot
StringmanualHost
StringmanualContextRoot
Stringcountry
StringcerberusUrl
StringtimeOutForCampaignExecution
intjobDsladditionalClasspath (optional)
StringadditionalParameters (optional)
java.lang.Object>
failOnMissingPlugin (optional)
booleanfailOnSeedCollision (optional)
booleanignoreExisting (optional)
booleanignoreMissingFiles (optional)
booleanlookupStrategy (optional)
JENKINS_ROOT, SEED_JOBremovedConfigFilesAction (optional)
IGNORE, DELETEremovedJobAction (optional)
IGNORE, DISABLE, DELETEremovedViewAction (optional)
IGNORE, DELETEsandbox (optional)
booleanscriptText (optional)
Stringtargets (optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
StringunstableOnDeprecation (optional)
booleanuseScriptText (optional)
booleanexecManrequestType (optional)
StringaltEMConfig (optional)
url
Stringcredentials
Stringbookmark (optional)
name
Stringfolder (optional)
StringexecParams (optional)
list (optional)
key
Stringvalue
StringpostExecute (optional)
action
Stringparams
StringprocessList (optional)
database
Stringproject
Stringprocesses
processPath
Stringfolder
StringrequestName
Stringrequest (optional)
name
StringwaitConfig (optional)
pollInterval
StringmaxRunTime
StringgoogleStorageBucketLifecyclecredentialsId
Stringbucket
Stringttl
intexportIpaappURL (optional)
StringarchiveDir (optional)
Specify the location of the path (usually BUILD_DIR specified by xcodebuild) to read the Archive for exporting the IPA file.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringassetPackManifestURL (optional)
StringcompileBitcode (optional)
booleancopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
StringmanualSigning (optional)
booleanpackResourcesAsset (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresourcesAssetURL (optional)
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanxcodeName (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringexportPackagesexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
StringexportProjectsexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExposeGuestInfo'vm
StringenvVariablePrefix
StringwaitForIp4
boolean$class: 'ExtensiveTestingBuilder'testPath
Stringlogin
Stringpassword
StringserverUrl
StringprojectName
Stringdebug
booleanfabricapiKey
StringbuildSecret
StringreleaseNotesType
StringnotifyTestersType
StringreleaseNotesParameter
StringreleaseNotesFile
StringapkPath
StringtestersEmails
StringtestersGroup
Stringorganization
StringuseAntStyleInclude
booleandownloadFeatureFilesserverAddress
StringprojectKey
StringtargetPath
StringfileOperationsfileOperations
fileCopyOperationincludes
Stringexcludes
StringtargetLocation
StringflattenFiles
booleanfileCreateOperationfileName
StringfileContent
StringfileDeleteOperationincludes
Stringexcludes
StringfileDownloadOperationurl
StringuserName
Stringpassword
StringtargetLocation
StringtargetFileName
StringfileJoinOperationsourceFile
StringtargetFile
StringfilePropertiesToJsonOperationsourceFile
StringtargetFile
StringfileRenameOperationsource
Stringdestination
StringfileTransformOperationincludes
Stringexcludes
StringfileUnTarOperationfilePath
StringtargetLocation
StringisGZIP
booleanfileUnZipOperationfilePath
StringtargetLocation
StringfileZipOperationfolderPath
StringfolderCopyOperationsourceFolderPath
StringdestinationFolderPath
StringfolderCreateOperationfolderPath
StringfolderDeleteOperationfolderPath
StringfolderRenameOperationsource
Stringdestination
StringfindbugscanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringexcludePattern (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
StringincludePattern (optional)
StringisRankActivated (optional)
booleanpattern (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
booleanfingerprintTo use this feature, all of the involved projects (not just the project in which a file is produced, but also the projects in which the file is used) need to use this and record fingerprints.
See this document for more details.
targets
module/dist/**/*.zip (see the
@includes of Ant fileset for the exact format). The base directory is
the workspace.
String$class: 'FireLineBuilder'fireLineTarget
csp
If you select "Yes", this plugin will set the following content of CSP to allow access to HTML with JS or CSS.
sandbox allow-scripts; default-src *; style-src * http://* 'unsafe-inline' 'unsafe-eval'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'
Warning:
There is a security risk if you select "Yes".
booleanblockBuild
If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
booleanconfiguration
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<fireline>
<args>
<!-- 序号对应的规则种类,用加号+相连
1:代码规范类
2:内存类
3:日志类
4:安全类
5:空指针
6:多线程
-->
<scanTypes>1+2+4+5+6</scanTypes>
<!--以上写法过滤了日志类的所有规则-->
<!--以下为过滤掉指定的单条规则,请加QQ群298228528获取规则名称-->
<filterRules>
<!--<filterRule ruleName="LogOnOffRule" />
<filterRule ruleName="LogBlockRule" />
<filterRule ruleName="LogAssignmentRule" />-->
</filterRules>
<!--过滤掉你不想检查的文件(注意:重复代码检查不支持过滤)-->
<filterFiles>
<!--过滤单个文件-->
<!--<filterFile Name="R.java"/>-->
<!--过滤整个文件夹-->
<!--<filterFile Name="/facebook/"/>-->
</filterFiles>
</args>
</fireline>
以上配置文件去掉了日志类的规则,所以火线扫描过程中就不会执行日志类规则的检查。
StringreportPath
StringreportFileName
StringbuildWithParameter
可通过配置使用build with parameter插件,在项目构建时灵活使用火线扫描。
例如:在项目配置中设置参数化构建参数。配置boolean类型参数fireline。
则在此输入框中填写${fireline}即可
Stringjdk
JDK to be used for this FireLine analysis.
Tips:
JDK1.7 or 1.8 is compatible with FireLine.
Stringjvm
合理设置JVM参数可以有效提高扫描效率,建议JVM最低配置如下:
"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
String$class: 'FitnesseBuilder'options
java.lang.String>
$class: 'FitnesseResultsRecorder'fitnessePathToXmlResultsIn
String$class: 'Fluentd'tag
StringfailBuild
booleanfileName
Stringjson
StringpushFromAgent
booleanflywayrunnerinstallationName
StringflywayCommand
Stringurl
Stringlocations
StringcommandLineArgs
StringcredentialsId
String$class: 'FortifyClean'buildID
StringaddJVMOptions (optional)
Stringdebug (optional)
booleanlogFile (optional)
StringmaxHeap (optional)
Stringverbose (optional)
booleanfortifyCloudScanbuildId
StringuseAutoHeap
booleanxmx
StringrmiWorkerMaxHeap
StringbuildLabel
StringbuildProject
StringbuildVersion
StringuseSsc
booleansscToken
StringupToken
StringversionId
StringscanArgs
Stringfilter
StringnoDefaultRules
booleandisableSourceRendering
booleandisableSnippets
booleanquick
booleanrules
StringuseParallelAnalysis
boolean$class: 'FortifyPollResults'bsiToken
StringpollingInterval
intclientId (optional)
StringclientSecret (optional)
StringoverrideGlobalConfig (optional)
booleanpersonalAccessToken (optional)
StringpolicyFailureBuildResultPreference (optional)
inttenantId (optional)
Stringusername (optional)
String$class: 'FortifyScan'buildID
StringaddJVMOptions (optional)
StringaddOptions (optional)
StringcustomRulepacks (optional)
Stringdebug (optional)
booleanlogFile (optional)
StringmaxHeap (optional)
StringresultsFile (optional)
Stringverbose (optional)
boolean$class: 'FortifyStaticAssessment'bsiToken
StringentitlementPreference (optional)
intincludeAllFiles (optional)
booleanincludeThirdPartyOverride (optional)
booleanisBundledAssessment (optional)
booleanisExpressAuditOverride (optional)
booleanisExpressScanOverride (optional)
booleanisRemediationPreferred (optional)
booleanoverrideGlobalConfig (optional)
booleanpersonalAccessToken (optional)
StringpurchaseEntitlements (optional)
booleanrunOpenSourceAnalysisOverride (optional)
booleantenantId (optional)
Stringusername (optional)
String$class: 'FortifyTranslate'buildID
StringprojectScanType
fortifyAdvancedadvOptions (optional)
StringfortifyDevenvdotnetAddOptions (optional)
StringdotnetProject (optional)
StringfortifyDotnetSrcdotnetAddOptions (optional)
StringdotnetFrameworkVersion (optional)
StringdotnetLibdirs (optional)
StringdotnetSrcFiles (optional)
StringfortifyGradlegradleOptions (optional)
StringgradleTasks (optional)
StringuseWrapper (optional)
booleanfortifyJavajavaAddOptions (optional)
StringjavaClasspath (optional)
StringjavaSrcFiles (optional)
StringjavaVersion (optional)
StringfortifyMaven3mavenOptions (optional)
StringfortifyMSBuilddotnetAddOptions (optional)
StringdotnetProject (optional)
StringfortifyOtherotherIncludesList (optional)
StringotherOptions (optional)
StringaddJVMOptions (optional)
Stringdebug (optional)
booleanexcludeList (optional)
StringlogFile (optional)
StringmaxHeap (optional)
Stringverbose (optional)
boolean$class: 'FortifyUpdate'updateServerURL (optional)
StringproxyURL (optional)
StringproxyUsername (optional)
StringproxyPassword (optional)
StringuseProxy (optional)
boolean$class: 'FortifyUpload'appName
StringappVersion
StringfailureCriteria (optional)
StringfilterSet (optional)
StringpollingInterval (optional)
StringresultsFile (optional)
StringfrugalTestinguserId
StringtestId
StringrunTag
StringgetJtl
booleanserverUrl (optional)
String$class: 'FtpRenameBuilder'ftpServer
StringftpPort
if you don't specify the port, the default port is 21.
intftpUser
StringftpPassword
hudson.util.Secret
ftpPath
Specify the path to your artifact.
StringartifactName (optional)
StringnewArtifactName (optional)
StringremoteDirectory (optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
String$class: 'FtpRenamePublisher'ftpServer
StringftpPort
if you don't specify the port, the default port is 21.
intftpUser
StringftpPassword
hudson.util.Secret
ftpPath
Specify the path to your artifact.
StringartifactName (optional)
StringnewArtifactName (optional)
StringremoteDirectory (optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
StringazureFunctionAppPublishazureCredentialsId
StringresourceGroup
StringappName
StringdeployOnlyIfSuccessful (optional)
booleanfilePath (optional)
The file paths that will be deployed.
You can use wildcards like **/*.js. See the includes attribute of Ant fileset for the exact format. Multiple files can be separated by ','. The base directory is the workspace. You can only deploy files that are located in your workspace.
Example: **/*.js,**/*.json
StringsourceDirectory (optional)
StringtargetDirectory (optional)
String$class: 'GatlingChecker'metrics
$class: 'GlobalOKRateMetric'rate
String$class: 'GlobalQpsMetric'qps
String$class: 'GlobalResponseTime95Metric'responseTime
String$class: 'GlobalResponseTime99Metric'responseTime
String$class: 'GlobalResponseTimeAvgMetric'responseTime
String$class: 'RequestOKRateMetric'requestName
Stringrate
String$class: 'RequestQpsMetric'requestName
Stringqps
String$class: 'RequestResponseTime95Metric'requestName
StringresponseTime
String$class: 'RequestResponseTime99Metric'requestName
StringresponseTime
String$class: 'RequestResponseTimeAvgMetric'requestName
StringresponseTime
String$class: 'GatlingPublisher'enabled
boolean$class: 'GetTestResults'domain
Stringproject
StringresultsDir
Stringconfigurations
testSetPath
Stringuser (optional)
Stringpassword (optional)
String$class: 'GhprbPullRequestMerge'mergeComment
StringonlyAdminsMerge
booleandisallowOwnCode
booleanfailOnNonMerge
booleandeleteOnMerge
booleanallowMergeWithoutTriggerPhrase
booleangitAutomergerreleaseBranchPattern
StringmergeRules
path
Stringresolution
KEEP_OLDER, KEEP_NEWER, MERGE_OLDER_TOP, MERGE_NEWER_TOPlogLevel
TRACE, DEBUG, INFO, WARN, ERRORremoteName
StringcheckoutFromRemote
booleangitbisectjobToRun
StringgoodStartCommit
StringbadEndCommit
StringsearchIdentifier
StringrevisionParameterName
StringretryCount
intcontinuesBuild
booleanminSuccessfulIterations
intoverrideGitCommand
booleangitCommand
String$class: 'GitBisectOnFailure'gitCommand
StringrevisionParameterName
StringoverrideGitCommand
boolean$class: 'GitChangelogRecorder'See Git Changelog Plugin for details on how to configure and use this plugin.
config
configFile (optional)
StringcreateFileTemplateContent (optional)
StringcreateFileTemplateFile (optional)
StringcreateFileUseTemplateContent (optional)
booleancreateFileUseTemplateFile (optional)
booleancustomIssues (optional)
name
Stringpattern
Stringlink
Stringtitle
StringdateFormat (optional)
Stringfile (optional)
StringfromReference (optional)
StringfromType (optional)
StringgitHubApi (optional)
StringgitHubApiTokenCredentialsId (optional)
StringgitHubIssuePattern (optional)
StringgitHubToken (optional)
StringgitLabApiTokenCredentialsId (optional)
StringgitLabProjectName (optional)
StringgitLabServer (optional)
StringgitLabToken (optional)
StringignoreCommitsIfMessageMatches (optional)
StringignoreCommitsWithoutIssue (optional)
booleanignoreTagsIfNameMatches (optional)
StringjiraIssuePattern (optional)
StringjiraPassword (optional)
StringjiraServer (optional)
StringjiraUsername (optional)
StringjiraUsernamePasswordCredentialsId (optional)
StringmediaWikiPassword (optional)
StringmediaWikiTemplateContent (optional)
StringmediaWikiTemplateFile (optional)
StringmediaWikiTitle (optional)
StringmediaWikiUrl (optional)
StringmediaWikiUseTemplateContent (optional)
booleanmediaWikiUseTemplateFile (optional)
booleanmediaWikiUsername (optional)
StringnoIssueName (optional)
StringreadableTagName (optional)
StringshowSummary (optional)
booleanshowSummaryTemplateContent (optional)
StringshowSummaryTemplateFile (optional)
StringshowSummaryUseTemplateContent (optional)
booleanshowSummaryUseTemplateFile (optional)
booleansubDirectory (optional)
StringtimeZone (optional)
StringtoReference (optional)
StringtoType (optional)
StringuntaggedName (optional)
StringuseConfigFile (optional)
booleanuseFile (optional)
booleanuseGitHub (optional)
booleanuseGitHubApiTokenCredentials (optional)
booleanuseGitLab (optional)
booleanuseGitLabApiTokenCredentials (optional)
booleanuseIgnoreTagsIfNameMatches (optional)
booleanuseJira (optional)
booleanuseJiraUsernamePasswordCredentialsId (optional)
booleanuseMediaWiki (optional)
booleanuseReadableTagName (optional)
booleanuseSubDirectory (optional)
boolean$class: 'GitHubCommitNotifier'resultOnFailure
StringstatusMessage (optional)
content
String$class: 'GitHubCommitStatusSetter'commitShaSource (optional)
$class: 'BuildDataRevisionShaSource'$class: 'ManuallyEnteredShaSource'sha
StringcontextSource (optional)
$class: 'DefaultCommitContextSource'$class: 'ManuallyEnteredCommitContextSource'context
StringerrorHandlers (optional)
$class: 'ChangingBuildStatusErrorHandler'result
String$class: 'ShallowAnyErrorHandler'reposSource (optional)
$class: 'AnyDefinedRepositorySource'$class: 'ManuallyEnteredRepositorySource'url
StringstatusBackrefSource (optional)
$class: 'BuildRefBackrefSource'$class: 'ManuallyEnteredBackrefSource'backref
StringstatusResultSource (optional)
$class: 'ConditionalStatusResultSource'results
$class: 'AnyBuildResult'message (optional)
Stringstate (optional)
String$class: 'BetterThanOrEqualBuildResult'message (optional)
Stringresult (optional)
Stringstate (optional)
String$class: 'DefaultStatusResultSource'$class: 'GitHubIssueNotifier'issueAppend (optional)
booleanissueBody (optional)
StringissueLabel (optional)
StringissueReopen (optional)
booleanissueRepo (optional)
StringissueTitle (optional)
StringgithubPRStatusPublisherstatusMsg
content
StringunstableAs
PENDING, SUCCESS, ERROR, FAILUREbuildMessage
successMsg
content
StringfailureMsg
content
StringstatusVerifier
buildStatus
StringerrorHandler
buildStatus
StringgithubPRClosePublisherstatusVerifier
buildStatus
StringerrorHandler
buildStatus
StringgithubPRCommentcomment
content
StringstatusVerifier
buildStatus
StringerrorHandler
buildStatus
StringgithubPRAddLabelslabelProperty
labels
Every new label on new line
StringstatusVerifier
buildStatus
StringerrorHandler
buildStatus
StringgithubPRRemoveLabelslabelProperty
labels
Every new label on new line
StringstatusVerifier
buildStatus
StringerrorHandler
buildStatus
StringgitHubPRStatusstatusMessage
content
String$class: 'GitHubSetCommitStatusBuilder'contextSource (optional)
$class: 'DefaultCommitContextSource'$class: 'ManuallyEnteredCommitContextSource'context
StringstatusMessage (optional)
content
String$class: 'GithubCoveragePublisher'filepath
StringcoverageXmlType (optional)
StringcoverageRateType (optional)
StringcomparisonOption (optional)
value (optional)
StringsonarProject (optional)
StringfixedCoverage (optional)
Stringgooglechatnotificationurl
Stringmessage
StringnotifyAborted (optional)
booleannotifyBackToNormal (optional)
booleannotifyFailure (optional)
booleannotifyNotBuilt (optional)
booleannotifySuccess (optional)
booleannotifyUnstable (optional)
booleansameThreadNotification (optional)
booleansuppressInfoLoggers (optional)
booleangprbuildinstallationName (optional)
Stringnames (optional)
Stringproj (optional)
-P switch. If not specified, GPRbuild uses the project file
default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
Stringswitches (optional)
Stringhabitattask (optional)
Stringdirectory (optional)
Stringartifact (optional)
Stringchannel (optional)
Stringorigin (optional)
StringbldrUrl (optional)
StringauthToken (optional)
StringlastBuildFile (optional)
Stringformat (optional)
StringsearchString (optional)
Stringcommand (optional)
Stringbinary (optional)
Stringpath (optional)
Stringdocker (optional)
booleanhealthAnalyzerproducts
$class: 'HealthAnalyzerLrStep'checkLrInstallation
booleancheckOsVersion
booleancheckFiles
filesList
field
Stringgreetname
StringuseFrench (optional)
booleanhockeyAppapplications
apiToken
StringappId
StringnotifyTeam
booleanfilePath
${BUILD_NUMBER} and they'll be expanded at build time.
e.g. "MyApp/build/Beta-iphoneos/MyApp-Beta-${BUILD_NUMBER}.ipa if your use ${BUILD_NUMBER} as technical version number (CFBundleShortVersionString).
Can use wildcards like 'module/dist/**/*.ipa'. See
the @includes of Ant fileset for the exact format.
StringdsymPath
${BUILD_NUMBER} and they'll be expanded at build time.
StringlibsPath
${BUILD_NUMBER} and they'll be expanded at build time.
Stringtags
${BUILD_NUMBER} and they'll be expanded at build time.
Stringteams
Stringmandatory
booleandownloadAllowed
booleanoldVersionHolder
numberOldVersions
StringsortOldVersions
StringstrategyOldVersions
StringreleaseNotesMethod
appCreationpublicPage
booleanchangelogfilefileName
StringisMarkdown
booleanmanualreleaseNotes
${BUILD_NUMBER} and they'll be expanded at build time.
StringisMarkdown
booleannoneversionCreationappId
StringversionCode (optional)
StringuploadMethod
appCreationpublicPage
booleanchangelogfilefileName
StringisMarkdown
booleanmanualreleaseNotes
${BUILD_NUMBER} and they'll be expanded at build time.
StringisMarkdown
booleannoneversionCreationappId
StringversionCode (optional)
StringbaseUrl (optional)
StringdebugMode (optional)
booleanfailGracefully (optional)
booleanhugobaseUrl (optional)
StringbuildFuture (optional)
booleandestination (optional)
Stringenvironment (optional)
StringhugoHome (optional)
Stringverbose (optional)
booleanhugoGitPublishtargetUrl
StringauthorEmail (optional)
StringauthorName (optional)
StringcommitLog (optional)
StringcommitterEmail (optional)
StringcommitterName (optional)
StringcredentialsId (optional)
StringpublishBranch (optional)
StringpublishDir (optional)
StringhugoGitSubmodulePublshauthorEmail (optional)
StringauthorName (optional)
StringcommitLog (optional)
StringcommitterEmail (optional)
StringcommitterName (optional)
StringcredentialsId (optional)
StringpublishBranch (optional)
StringpublishDir (optional)
String$class: 'HyperBuilder'image
Stringcommands
StringimportPackagesimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
StringimportProjectsimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
StringinfluxDbQuerycheckName
StringinfluxQuery
StringexpectedThreshold
doublemarkUnstable (optional)
booleanretryCount (optional)
intretryInterval (optional)
intshowResults (optional)
booleaninfluxDbPublishercustomData (optional)
java.lang.Object>
customDataMap (optional)
java.lang.Object>>
customDataMapTags (optional)
java.lang.String>>
customDataTags (optional)
java.lang.String>
customPrefix (optional)
StringcustomProjectName (optional)
Useful to easily group metrics for different jobs in multi branch pipeline jobs.
StringjenkinsEnvParameterField (optional)
Current build parameters and/or environment variables can be used in the form of ${PARAM}
StringjenkinsEnvParameterTag (optional)
Current build parameters and/or environment variables can be used in the form of ${PARAM}
StringmeasurementName (optional)
StringreplaceDashWithUnderscore (optional)
i.e. "my-custom-tag" → "my_custom_tag".
booleanselectedTarget (optional)
StringinsightAppSecregion
StringinsightCredentialsId
StringappId
StringscanConfigId
StringbuildAdvanceIndicator
StringvulnerabilityQuery
vulnerability.severity='HIGH'
StringmaxScanPendingDuration
0d 5h 30m
StringmaxScanExecutionDuration
0d 5h 30m
StringenableScanResults
boolean$class: 'IqPolicyEvaluatorBuildStep'iqStage
StringiqApplication
manualApplicationapplicationId
StringselectedApplicationapplicationId
StringiqScanPatterns
**/target/*.war or
**/target/*.ear. If unspecified, the scan will default to the patterns
**/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
scanPattern
StringiqModuleExcludes
**/nexus-iq/module.xml) to be ignored, e.g.
**/my-module/target/**, **/another-module/target/**. If unspecified all modules will contribute dependency information (if any) to the scan.
moduleExclude
StringfailBuildOnNetworkError
booleanjobCredentialsId
- none -, otherwise select different credentials.
StringadvancedProperties
key1=value1
key2=value2
String$class: 'IronMQNotifier'projectId
Stringtoken
StringqueueName
StringpreferredServerName
Stringsend_success
booleansend_failure
booleansend_unstable
booleanexpirySeconds
long$class: 'IssueFieldUpdateStep'issueSelector (optional)
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'fieldId (optional)
StringfieldValue (optional)
String$class: 'JDCodeDeployPublisher'ossBucket
StringossObject
StringapplicationName
StringdeploymentGroupName
StringregionId
StringwaitForCompletion
If checked, this build will wait for the JDCloud CodeDeploy deployment to finish (with either success or failure). Polling Timeout, below, sets the maximum amount of time to wait.
If unchecked, the deployment will be handed off to JDCloud CodeDeploy and the build will move on to the next step.
The build will be marked a failure if either the timeout is reached or the deployment fails. The build log will indicate which.
booleanpollingTimeoutSec
longpollingFreqSec
longdoDeploy
booleanaccessKey
JDCloud Access and Secret keys to use for this deployment.
StringsecretKey
JDCloud Access and Secret keys to use for this deployment.
hudson.util.Secret
includes
StringdownloadUrl
StringdeploySource
Stringexcludes
Stringsubdirectory
StringpublishUNITPublishes the UNIT reports of all configured ECU-TEST packages or projects in this job.
These UNIT reports are generated automatically in this post-build step.
publishUNIT(String toolName, double unstableThreshold, double failedThreshold) : void
publishUNIT(ETInstallation installation, double unstableThreshold, double failedThreshold, boolean archiving, boolean keepAll) : void
ETInstance.publishUNIT(double unstableThreshold, double failedThreshold, boolean archiving, boolean keepAll) : void
publishUNIT('ECU-TEST', 10, 20)
def instance = ET.installation('ECU-TEST')
publishUNIT installation: instance.installation, unstableThreshold: 10, failedThreshold: 20
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishUNIT()
toolName
StringallowMissing (optional)
booleanarchiving (optional)
booleanfailedThreshold (optional)
doubleinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanrunOnFailed (optional)
booleanunstableThreshold (optional)
double$class: 'JUnitResultArchiver'To use this feature, first set up your build to run tests, then specify the path to JUnit XML files in the Ant glob syntax, such as **/build/test-reports/*.xml. Be sure not to include any non-report files into this pattern. You can specify multiple patterns of files separated by commas.
Once there are a few builds running with test results, you should start seeing something like this.
testResults
StringallowEmptyResults (optional)
booleanhealthScaleFactor (optional)
1.0
0.0 will disable the test result contribution to build health score.0.1 means that 10% of tests failing will score 99% health0.5 means that 10% of tests failing will score 95% health1.0 means that 10% of tests failing will score 90% health2.0 means that 10% of tests failing will score 80% health2.5 means that 10% of tests failing will score 75% health5.0 means that 10% of tests failing will score 50% health10.0 means that 10% of tests failing will score 0% healthdoublekeepLongStdio (optional)
booleantestDataPublishers (optional)
$class: 'AttachmentPublisher'$class: 'AutomateTestDataPublisher'$class: 'ClaimTestDataPublisher'$class: 'JUnitFlakyTestDataPublisher'jiraTestResultReporterconfigs
jiraSelectableArrayFieldfieldKey
Stringvalues
value
StringjiraSelectableFieldfieldKey
Stringvalue
StringjiraStringArrayFieldfieldKey
Stringvalues
value
StringjiraStringFieldfieldKey
Stringvalue
Insert a string value.
You can include Jenkins Environment variables (see link), or the following variables defined by this plugin:
Variable usage: ${VAR_NAME}CRFL - new line
DEFAULT_SUMMARY - configured in the global configuration page
DEFAULT_DESCRIPTION - configured in the global configuration page
TEST_RESULT
TEST_NAME
TEST_FULL_NAME
TEST_STACK_TRACE
TEST_ERROR_DETAILS
TEST_DURATION
TEST_PACKAGE_NAME
TEST_STDERR
TEST_STDOUT
TEST_OVERVIEW
TEST_AGE
TEST_PASS_COUNT
TEST_SKIPPED_COUNT
TEST_FAIL_SINCE
TEST_IS_REGRESSION - expands to true/false
BUILD_RESULT
String$class: 'UserFields'fieldKey
Stringvalue
Insert the username.
For example if you have a user with:
Display Name: John Doe, Username: johndoe, Email: johndoe@email.com,
you need to write johndoe in this field. Any other value (like display name, or email) will not work.
StringprojectKey
StringissueType
StringautoRaiseIssue
booleanautoResolveIssue
booleanautoUnlinkIssue
boolean$class: 'JunitResultPublisher'urlOverride
String$class: 'PerfSigTestDataPublisher'dynatraceProfile
String$class: 'SahaginTestDataPublishser'$class: 'SauceOnDemandReportPublisher'jobVisibility (optional)
String$class: 'StabilityTestDataPublisher'$class: 'TestReporter'$class: 'JUnitTestReportPublisher'reportsDirectory
StringfileIncludePattern
StringfileExcludePattern
StringmarkAsUnstable
booleancopyHTMLInWorkspace
booleanjacocobuildOverBuild (optional)
booleanchangeBuildStatus (optional)
booleanclassPattern (optional)
StringdeltaBranchCoverage (optional)
StringdeltaClassCoverage (optional)
StringdeltaComplexityCoverage (optional)
StringdeltaInstructionCoverage (optional)
StringdeltaLineCoverage (optional)
StringdeltaMethodCoverage (optional)
StringexclusionPattern (optional)
StringexecPattern (optional)
StringinclusionPattern (optional)
StringmaximumBranchCoverage (optional)
StringmaximumClassCoverage (optional)
StringmaximumComplexityCoverage (optional)
StringmaximumInstructionCoverage (optional)
StringmaximumLineCoverage (optional)
StringmaximumMethodCoverage (optional)
StringminimumBranchCoverage (optional)
StringminimumClassCoverage (optional)
StringminimumComplexityCoverage (optional)
StringminimumInstructionCoverage (optional)
StringminimumLineCoverage (optional)
StringminimumMethodCoverage (optional)
StringskipCopyOfSrcFiles (optional)
booleansourceExclusionPattern (optional)
StringsourceInclusionPattern (optional)
StringsourcePattern (optional)
String$class: 'JavadocArchiver'javadocDir
StringkeepAll
If you leave this option unchecked, Jenkins will only keep the latest Javadoc, so older Javadoc will be overwritten as new builds succeed.
booleanSoapUIPropathToTestrunner
StringpathToProjectFile
Stringenvironment (optional)
StringprojectPassword (optional)
StringtestCase (optional)
StringtestSuite (optional)
String$class: 'JgivenReportGenerator'reportConfigs
$class: 'AsciiDocReportConfig'$class: 'HtmlReportConfig'customCssFile (optional)
StringcustomJsFile (optional)
Stringtitle (optional)
String$class: 'TextReportConfig'excludeEmptyScenarios (optional)
booleanjgivenResults (optional)
String$class: 'JiraIssueUpdateBuilder'jqlSearch
Example:
or (e.g., combined with a JIRA Issue Parameter, selecting one issue from a JQL result set):project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
issue = $ISSUE_ID
StringworkflowActionName
Stringcomment
String$class: 'JiraIssueUpdater'issueSelector
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'scm
$class: 'AWSCodePipelineSCM'name
StringclearWorkspace
booleanregion
StringawsAccessKey
In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringawsSecretKey
>In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringproxyHost
You might need a proxy host address if you are hosting Jenkins on a private network. The proxy name can be an IP address or DNS address. The AWS CodePipeline Plugin for Jenkins requires internet access. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
StringproxyPort
You might need a proxy port for your proxy host address if you are hosting Jenkins on a private network. The proxy port is a number, might be on port 8080, 3128, or 8443, depending on your network protocols and security settings. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
Stringcategory
This is the category of the action type in AWS CodePipeline, and is usually either Build or Test. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringprovider
This is the provider name of the action type in AWS CodePipeline. You must provide this exact string when adding an action for Jenkins in AWS CodePipeline. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringversion
Leave the default as 1.
Stringaccurevdepot
Stringstream
StringserverName (optional)
StringserverUUID (optional)
StringwspaceORreftree (optional)
StringaccurevTool (optional)
Stringcleanreftree (optional)
booleandirectoryOffset (optional)
StringdontPopContent (optional)
booleanfilterForPollSCM (optional)
StringignoreStreamParent (optional)
booleanreftree (optional)
StringsnapshotNameFormat (optional)
StringsubPath (optional)
StringsubPathOnly (optional)
booleansynctime (optional)
booleanuseSnapshot (optional)
booleanworkspace (optional)
String$class: 'BazaarSCM'source
Stringcleantree
booleanbrowser
$class: 'Loggerhead'url
String$class: 'OpenGrok'url
StringrootModule
Stringcheckout
boolean$class: 'BitKeeperSCM'parent
StringlocalRepository
StringusePull
booleanquiet
boolean$class: 'BlameSubversionSCM'if it is false and the build is not triggered by upstream job,
the plugin will not collect any svn info from upstream job.
else the plugin will collect svn info from latest upstream job
alwaysCollectSVNInfo
boolean$class: 'CCUCMScm'loadModule
Stringnewest
booleanmode
$class: 'PollChildMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
boolean$class: 'PollRebaseMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
booleanexcludeList (optional)
String$class: 'PollSelfMode'levelToPoll
Stringcomponent (optional)
Stringnewest (optional)
boolean$class: 'PollSiblingMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
booleanuseHyperLinkForPolling (optional)
boolean$class: 'PollSubscribeMode'levelToPoll
StringcomponentsToMonitor
componentSelection
StringjobsToMonitor
jobname
Stringignores
StringjobName (optional)
StringcascadePromotion (optional)
booleancomponent (optional)
Stringnewest (optional)
booleanstream
StringtreatUnstable
StringnameTemplate
StringforceDeliver
booleanrecommend
booleanmakeTag
booleansetDescription
booleanbuildProject
StringremoveViewPrivateFiles
booleantrimmedChangeSet
booleandiscard
boolean$class: 'CVSSCM'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanlegacy
If you have multiple modules to check out, this option is forced (otherwise they'll overlap.)
This affects other path specifiers, such as artifact archivers --- you now specify "build/foo.jar" instead of "foo/build/foo.jar".
booleanskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
booleancheckoutCurrentTimestamp
The build quiet period is designed to assist with CVS checkouts by waiting for a specific period of time without commits. Normally you want the checkout to reflect the time when the quiet period was exited successfully. Select this option if you need to re-enable the legacy behaviour of Jenkins, i.e. using the time that the build started checking out as the timestamp for the checkout operation. Note: enabling this option can result in the quiet period being defeated especially in those cases where the build is not able to start immediately after exiting the quiet period.
boolean$class: 'ClearCaseSCM'branch
Stringlabel
StringextractConfigSpec
booleanconfigSpecFileName
StringrefreshConfigSpec
booleanrefreshConfigSpecCommand
StringconfigSpec
StringviewTag
Stringuseupdate
booleanextractLoadRules
booleanloadRules
StringuseOtherLoadRulesForPolling
booleanloadRulesForPolling
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleandoNotUpdateConfigSpec
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringuseTimeRule
booleancreateDynView
booleanviewPath
Stringchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
String$class: 'ClearCaseUcmBaselineSCM'$class: 'ClearCaseUcmSCM'stream
Stringloadrules
StringviewTag
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleanuseUpdate
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringoverrideBranchName
StringcreateDynView
booleanfreezeCode
booleanrecreateView
booleanallocateViewName
booleanviewPath
StringuseManualLoadRules
booleanchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
StringbuildFoundationBaseline
If checked, instead of creating a view on the current stream, the job will look up the current foundation baselines for the given stream and work in readonly on these baselines. If polling is enabled, the build will be triggered every time a new foundation baseline is detected on the given stream.
boolean$class: 'CloneWorkspaceSCM'parentJobName
Stringcriteria
String$class: 'CmvcSCM'family
Stringbecome
Stringreleases
StringcheckoutScript
StringtrackViewReportWhereClause
String$class: 'ConfigurationRotator'acrs
$class: 'ClearCaseUCM'pvobName
Stringcontribute
Contribute data to a global database. Defined in the Compatibility Action Storage Plugin.
booleantargets
baselineName
Stringlevel
INITIAL, BUILT, TESTED, RELEASED, REJECTEDfixed
booleanuseNewest (optional)
boolean$class: 'Git'targets
name
Stringrepository
Stringbranch
StringcommitId
Stringfixed
booleanuseNewest (optional)
boolean$class: 'CvsProjectset'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanusername
Stringpassword
Stringbrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
boolean$class: 'DarcsScm'source
StringlocalDir
Stringclean
booleanbrowser
$class: 'DarcsWeb'url
Stringrepo
String$class: 'Darcsden'url
String$class: 'DelegateSCM'clazz
String$class: 'DimensionsSCM'project
Stringfolders
StringpathsToExclude
Stringworkarea
StringcanJobDelete
booleancanJobForce
booleancanJobRevert
booleanjobUserName
StringjobPasswd
StringjobServer
StringjobDatabase
StringcanJobUpdate
booleanjobTimeZone
StringjobWebUrl
Stringdirectory
Stringpermissions
Stringeol
StringcanJobExpand
booleancanJobNoMetadata
booleancanJobNoTouch
booleanforceAsSlave
boolean$class: 'DrushMakefileSCM'makefile
Specify the content of the Makefile. Support for YAML Makefiles depends on the version of Drush you have installed.
This example will generate a vanilla Drupal 7.38:
api=2
core=7.x
projects[drupal][version]=7.38
Stringroot
String$class: 'EndevorConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
Stringfilesystempath
The file path for the source code.
e.g. \\Server1\project1\src or c:\myproject\src
Note for distributed build environment, please make sure the path is accessible on remote node(s)
StringclearWorkspace
If true, the system will delete all existing files/sub-folders in workspace before checking-out. Poll changes will not be affected by this setting.
booleancopyHidden
If true, the system will copy hidden files and folders as well. Default is false.
booleanfilterSettings
includeFilter
booleanselectors
You can apply wildcard filter(s) when detecting changes and copying files. By default, the system will filter out hidden files, on Unix, that means files/folder starting with ".", on Windows, that means files/folders with "hidden" attribute. You may want to filter out, e.g. files with ".tmp" extension.
Note: filters are applied on both sides, source and destination (i.e. the workspace). E.g. if you filter out ".tmp" files, all ".tmp" files currently in workspace will not be removed.
wildcard
ANT style wildcard.
To include just *.java, set filter type to "Include" and type add "*.java" (without quote) in the wildcard. To exclude *.exe" and all JUnit test cases, set filter type to "Exclude" and add two wildcard, one for "*.dll" and one for "*Test*"
To exclude a directory, set filter to "**/dir_to_exclude/**"
Note: (1) the wildcard is case insensitive, (2) all backslashes (\) will be replaced with slashes (/)
String$class: 'FeatureBranchAwareMercurialSCM'installation
Stringsource
Stringbranch
Stringmodules
Stringsubdir
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
Stringbrowser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean
booleanbranchPattern
String$class: 'GeneXusServerSCM'gxInstallationId
StringserverURL
StringcredentialsId
StringkbName
StringkbVersion
StringlocalKbPath
StringlocalKbVersion
StringkbDbServerInstance
StringkbDbCredentialsId
StringkbDbName
StringkbDbInSameFolder
boolean$class: 'GitSCM'userRemoteConfigs
${SUPER_PROJECT_URL}/${SUBMODULE}, rather than relying on information from .gitmodules.url
Stringname
You normally want to specify this when you have multiple remote repositories.
Stringrefspec
In other words, the default refspec is "+refs/heads/*:refs/remotes/REPOSITORYNAME/*" where REPOSITORYNAME is the value you specify in the above "name of repository" textbox.
When do you want to modify this value? A good example is when you want to just retrieve one branch. For example, +refs/heads/master:refs/remotes/origin/master would only retrieve the master branch and nothing else.
The plugin uses a default refspec for its initial fetch, unless the "Advanced Clone Option" is set to honor refspec. This keeps compatibility with previous behavior, and allows the job definition to decide if the refspec should be honored on initial clone.
Multiple refspecs can be entered by separating them with a space character. +refs/heads/master:refs/remotes/origin/master +refs/heads/develop:refs/remotes/origin/develop retrieves the master branch and the develop branch and nothing else.
See the term definition in Git user manual for more details.
StringcredentialsId
Stringbranches
name
Specify the branches if you'd like to track a specific branch in a repository. If left blank, all branches will be examined for changes and built.
The safest way is to use the refs/heads/<branchName> syntax. This way the expected branch is unambiguous.
If your branch name has a / in it make sure to use the full reference above. When not presented with a full path the plugin will only use the part of the string right of the last slash. Meaning foo/bar will actually match bar
.If you use a wildcard branch specifier, with a slash (e.g. release/), you'll need to specify the origin repository in the branch names to make sure changes are picked up. So e.g. origin/release/
Possible options:
StringdoGenerateSubmoduleConfigurations
booleansubmoduleCfg
hudson.plugins.git.SubmoduleConfig
browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringgitTool
Stringextensions
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its value is an empty string or "**", then the branch name is computed from the remote branch without the origin. In that case, a remote branch origin/master will be checked out to a local branch named master, and a remote branch origin/develop/new-feature will be checked out to a local branch named develop/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'Specify the paths that you'd like to sparse checkout. This may be used for saving space (Think about a reference repository). Be sure to use a recent version of Git, at least above 1.7.10
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'$class: 'HarvestSCM'broker
StringpasswordFile
StringuserId
Stringpassword
StringprojectName
Stringstate
StringviewPath
StringclientPath
StringprocessName
StringrecursiveSearch
StringuseSynchronize
booleanextraOptions
String$class: 'IspwConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringserverStream
StringserverApplication
StringserverLevel
StringlevelOption
StringcomponentType
StringfolderName
StringispwDownloadAll
booleantargetFolder
String$class: 'IspwContainerConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringcontainerName
StringcontainerType
StringserverLevel
StringcomponentType
StringispwDownloadAll
booleantargetFolder
String$class: 'MercurialSCM'source
Stringbrowser (optional)
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean (optional)
booleancredentialsId (optional)
StringdisableChangeLog (optional)
booleaninstallation (optional)
Stringmodules (optional)
Stringrevision (optional)
default branch.)
StringrevisionType (optional)
BRANCH, TAG, CHANGESET, REVSETsubdir (optional)
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
String$class: 'MergeBotUpdater'$class: 'MultiSCM'scmList
$class: 'AWSCodePipelineSCM'name
StringclearWorkspace
booleanregion
StringawsAccessKey
In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringawsSecretKey
>In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringproxyHost
You might need a proxy host address if you are hosting Jenkins on a private network. The proxy name can be an IP address or DNS address. The AWS CodePipeline Plugin for Jenkins requires internet access. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
StringproxyPort
You might need a proxy port for your proxy host address if you are hosting Jenkins on a private network. The proxy port is a number, might be on port 8080, 3128, or 8443, depending on your network protocols and security settings. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
Stringcategory
This is the category of the action type in AWS CodePipeline, and is usually either Build or Test. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringprovider
This is the provider name of the action type in AWS CodePipeline. You must provide this exact string when adding an action for Jenkins in AWS CodePipeline. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringversion
Leave the default as 1.
Stringaccurevdepot
Stringstream
StringserverName (optional)
StringserverUUID (optional)
StringwspaceORreftree (optional)
StringaccurevTool (optional)
Stringcleanreftree (optional)
booleandirectoryOffset (optional)
StringdontPopContent (optional)
booleanfilterForPollSCM (optional)
StringignoreStreamParent (optional)
booleanreftree (optional)
StringsnapshotNameFormat (optional)
StringsubPath (optional)
StringsubPathOnly (optional)
booleansynctime (optional)
booleanuseSnapshot (optional)
booleanworkspace (optional)
String$class: 'BazaarSCM'source
Stringcleantree
booleanbrowser
$class: 'Loggerhead'url
String$class: 'OpenGrok'url
StringrootModule
Stringcheckout
boolean$class: 'BitKeeperSCM'parent
StringlocalRepository
StringusePull
booleanquiet
boolean$class: 'BlameSubversionSCM'if it is false and the build is not triggered by upstream job,
the plugin will not collect any svn info from upstream job.
else the plugin will collect svn info from latest upstream job
alwaysCollectSVNInfo
boolean$class: 'CCUCMScm'loadModule
Stringnewest
booleanmode
$class: 'PollChildMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
boolean$class: 'PollRebaseMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
booleanexcludeList (optional)
String$class: 'PollSelfMode'levelToPoll
Stringcomponent (optional)
Stringnewest (optional)
boolean$class: 'PollSiblingMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
booleanuseHyperLinkForPolling (optional)
boolean$class: 'PollSubscribeMode'levelToPoll
StringcomponentsToMonitor
componentSelection
StringjobsToMonitor
jobname
Stringignores
StringjobName (optional)
StringcascadePromotion (optional)
booleancomponent (optional)
Stringnewest (optional)
booleanstream
StringtreatUnstable
StringnameTemplate
StringforceDeliver
booleanrecommend
booleanmakeTag
booleansetDescription
booleanbuildProject
StringremoveViewPrivateFiles
booleantrimmedChangeSet
booleandiscard
boolean$class: 'CVSSCM'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanlegacy
If you have multiple modules to check out, this option is forced (otherwise they'll overlap.)
This affects other path specifiers, such as artifact archivers --- you now specify "build/foo.jar" instead of "foo/build/foo.jar".
booleanskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
booleancheckoutCurrentTimestamp
The build quiet period is designed to assist with CVS checkouts by waiting for a specific period of time without commits. Normally you want the checkout to reflect the time when the quiet period was exited successfully. Select this option if you need to re-enable the legacy behaviour of Jenkins, i.e. using the time that the build started checking out as the timestamp for the checkout operation. Note: enabling this option can result in the quiet period being defeated especially in those cases where the build is not able to start immediately after exiting the quiet period.
boolean$class: 'ClearCaseSCM'branch
Stringlabel
StringextractConfigSpec
booleanconfigSpecFileName
StringrefreshConfigSpec
booleanrefreshConfigSpecCommand
StringconfigSpec
StringviewTag
Stringuseupdate
booleanextractLoadRules
booleanloadRules
StringuseOtherLoadRulesForPolling
booleanloadRulesForPolling
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleandoNotUpdateConfigSpec
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringuseTimeRule
booleancreateDynView
booleanviewPath
Stringchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
String$class: 'ClearCaseUcmBaselineSCM'$class: 'ClearCaseUcmSCM'stream
Stringloadrules
StringviewTag
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleanuseUpdate
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringoverrideBranchName
StringcreateDynView
booleanfreezeCode
booleanrecreateView
booleanallocateViewName
booleanviewPath
StringuseManualLoadRules
booleanchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
StringbuildFoundationBaseline
If checked, instead of creating a view on the current stream, the job will look up the current foundation baselines for the given stream and work in readonly on these baselines. If polling is enabled, the build will be triggered every time a new foundation baseline is detected on the given stream.
boolean$class: 'CloneWorkspaceSCM'parentJobName
Stringcriteria
String$class: 'CmvcSCM'family
Stringbecome
Stringreleases
StringcheckoutScript
StringtrackViewReportWhereClause
String$class: 'ConfigurationRotator'acrs
$class: 'ClearCaseUCM'pvobName
Stringcontribute
Contribute data to a global database. Defined in the Compatibility Action Storage Plugin.
booleantargets
baselineName
Stringlevel
INITIAL, BUILT, TESTED, RELEASED, REJECTEDfixed
booleanuseNewest (optional)
boolean$class: 'Git'targets
name
Stringrepository
Stringbranch
StringcommitId
Stringfixed
booleanuseNewest (optional)
boolean$class: 'CvsProjectset'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanusername
Stringpassword
Stringbrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
boolean$class: 'DarcsScm'source
StringlocalDir
Stringclean
booleanbrowser
$class: 'DarcsWeb'url
Stringrepo
String$class: 'Darcsden'url
String$class: 'DelegateSCM'clazz
String$class: 'DimensionsSCM'project
Stringfolders
StringpathsToExclude
Stringworkarea
StringcanJobDelete
booleancanJobForce
booleancanJobRevert
booleanjobUserName
StringjobPasswd
StringjobServer
StringjobDatabase
StringcanJobUpdate
booleanjobTimeZone
StringjobWebUrl
Stringdirectory
Stringpermissions
Stringeol
StringcanJobExpand
booleancanJobNoMetadata
booleancanJobNoTouch
booleanforceAsSlave
boolean$class: 'DrushMakefileSCM'makefile
Specify the content of the Makefile. Support for YAML Makefiles depends on the version of Drush you have installed.
This example will generate a vanilla Drupal 7.38:
api=2
core=7.x
projects[drupal][version]=7.38
Stringroot
String$class: 'EndevorConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
Stringfilesystempath
The file path for the source code.
e.g. \\Server1\project1\src or c:\myproject\src
Note for distributed build environment, please make sure the path is accessible on remote node(s)
StringclearWorkspace
If true, the system will delete all existing files/sub-folders in workspace before checking-out. Poll changes will not be affected by this setting.
booleancopyHidden
If true, the system will copy hidden files and folders as well. Default is false.
booleanfilterSettings
includeFilter
booleanselectors
You can apply wildcard filter(s) when detecting changes and copying files. By default, the system will filter out hidden files, on Unix, that means files/folder starting with ".", on Windows, that means files/folders with "hidden" attribute. You may want to filter out, e.g. files with ".tmp" extension.
Note: filters are applied on both sides, source and destination (i.e. the workspace). E.g. if you filter out ".tmp" files, all ".tmp" files currently in workspace will not be removed.
wildcard
ANT style wildcard.
To include just *.java, set filter type to "Include" and type add "*.java" (without quote) in the wildcard. To exclude *.exe" and all JUnit test cases, set filter type to "Exclude" and add two wildcard, one for "*.dll" and one for "*Test*"
To exclude a directory, set filter to "**/dir_to_exclude/**"
Note: (1) the wildcard is case insensitive, (2) all backslashes (\) will be replaced with slashes (/)
String$class: 'FeatureBranchAwareMercurialSCM'installation
Stringsource
Stringbranch
Stringmodules
Stringsubdir
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
Stringbrowser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean
booleanbranchPattern
String$class: 'GeneXusServerSCM'gxInstallationId
StringserverURL
StringcredentialsId
StringkbName
StringkbVersion
StringlocalKbPath
StringlocalKbVersion
StringkbDbServerInstance
StringkbDbCredentialsId
StringkbDbName
StringkbDbInSameFolder
boolean$class: 'GitSCM'userRemoteConfigs
${SUPER_PROJECT_URL}/${SUBMODULE}, rather than relying on information from .gitmodules.url
Stringname
You normally want to specify this when you have multiple remote repositories.
Stringrefspec
In other words, the default refspec is "+refs/heads/*:refs/remotes/REPOSITORYNAME/*" where REPOSITORYNAME is the value you specify in the above "name of repository" textbox.
When do you want to modify this value? A good example is when you want to just retrieve one branch. For example, +refs/heads/master:refs/remotes/origin/master would only retrieve the master branch and nothing else.
The plugin uses a default refspec for its initial fetch, unless the "Advanced Clone Option" is set to honor refspec. This keeps compatibility with previous behavior, and allows the job definition to decide if the refspec should be honored on initial clone.
Multiple refspecs can be entered by separating them with a space character. +refs/heads/master:refs/remotes/origin/master +refs/heads/develop:refs/remotes/origin/develop retrieves the master branch and the develop branch and nothing else.
See the term definition in Git user manual for more details.
StringcredentialsId
Stringbranches
name
Specify the branches if you'd like to track a specific branch in a repository. If left blank, all branches will be examined for changes and built.
The safest way is to use the refs/heads/<branchName> syntax. This way the expected branch is unambiguous.
If your branch name has a / in it make sure to use the full reference above. When not presented with a full path the plugin will only use the part of the string right of the last slash. Meaning foo/bar will actually match bar
.If you use a wildcard branch specifier, with a slash (e.g. release/), you'll need to specify the origin repository in the branch names to make sure changes are picked up. So e.g. origin/release/
Possible options:
StringdoGenerateSubmoduleConfigurations
booleansubmoduleCfg
hudson.plugins.git.SubmoduleConfig
browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringgitTool
Stringextensions
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its value is an empty string or "**", then the branch name is computed from the remote branch without the origin. In that case, a remote branch origin/master will be checked out to a local branch named master, and a remote branch origin/develop/new-feature will be checked out to a local branch named develop/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'Specify the paths that you'd like to sparse checkout. This may be used for saving space (Think about a reference repository). Be sure to use a recent version of Git, at least above 1.7.10
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'$class: 'HarvestSCM'broker
StringpasswordFile
StringuserId
Stringpassword
StringprojectName
Stringstate
StringviewPath
StringclientPath
StringprocessName
StringrecursiveSearch
StringuseSynchronize
booleanextraOptions
String$class: 'IspwConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringserverStream
StringserverApplication
StringserverLevel
StringlevelOption
StringcomponentType
StringfolderName
StringispwDownloadAll
booleantargetFolder
String$class: 'IspwContainerConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringcontainerName
StringcontainerType
StringserverLevel
StringcomponentType
StringispwDownloadAll
booleantargetFolder
String$class: 'MercurialSCM'source
Stringbrowser (optional)
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean (optional)
booleancredentialsId (optional)
StringdisableChangeLog (optional)
booleaninstallation (optional)
Stringmodules (optional)
Stringrevision (optional)
default branch.)
StringrevisionType (optional)
BRANCH, TAG, CHANGESET, REVSETsubdir (optional)
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
String$class: 'MergeBotUpdater'$class: 'MultiSCM'$class: 'OpenShiftImageStreams'imageStreamName
Stringtag
StringapiURL
Stringnamespace
StringauthToken
Stringverbose
String$class: 'PdsConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
String$class: 'PerforceSCM'p4User
Stringp4Passwd
Stringp4Client
Stringp4Port
StringprojectOptions
Stringp4Tool
Stringp4SysRoot
Stringp4SysDrive
Stringp4Label
Stringp4Counter
Stringp4UpstreamProject
StringlineEndValue
Stringp4Charset
Stringp4CommandCharset
StringclientOwner
StringupdateCounterValue
booleanforceSync
booleandontUpdateServer
booleanalwaysForceSync
booleancreateWorkspace
booleanupdateView
booleandisableChangeLogOnly
booleandisableSyncOnly
booleanshowIntegChanges
booleandontUpdateClient
booleanexposeP4Passwd
booleanpollOnlyOnMaster
booleanslaveClientNameFormat
StringfirstChange
intfileLimit
intbrowser
$class: 'FishEyePerforce'url
StringrootModule
String$class: 'P4Web'url
String$class: 'Perfbrowse'url
StringexcludedUsers
StringexcludedFiles
StringexcludedFilesCaseSensitivity
booleandepotType
value
Stringp4Stream
StringclientSpec
StringprojectPath
StringcleanWorkspace
cleanType
value
StringrestoreChangedDeletedFiles
booleanwipeRepoBeforeBuild
booleanuseViewMask
viewMask
StringuseViewMaskForPolling
booleanuseViewMaskForSyncing
booleanuseViewMaskForChangeLog
booleanperforcecredential
Select the appropriate credential for the Perforce connection. Perforce Credentials are defined in the Jenkins Credentials plugin here.
There are two types:
Stringworkspace
Select the appropriate Perforce workspace behaviour from the list. Not all modes will suit all Jenkins Job build types.
There are five types:
manualSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
Stringspec
allwrite
booleanclobber
booleancompress
booleanlocked
booleanmodtime
booleanrmdir
booleanstreamName
Stringline
Set line-ending character(s) for client text files.
linefeed: UNIX style.
carriage return: Macintosh style. (obsolete)
carriage return-linefeed: Windows style.
hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
Stringview
Lines to map depot files into the client workspace.
Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
StringchangeView
Stringtype
Type of client: writeable/readonly/partitioned/graph
By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
StringserverID
Stringbackup
Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
booleancleanup
booleansyncID (optional)
StringspecFileSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
StringspecPath
StringsyncID (optional)
StringstaticSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
StringsyncID (optional)
StringstreamSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanstreamName
Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
For example: //stream-depot/main-streamStringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
StringtemplateSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleantemplateName
Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
Stringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
Stringfilter
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringpopulate
Perforce will populate the workspace with the file revisions needed for the build. The different options effect the way the workspace is cleaned and the file revisions are updated.
There are three options:
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringbrowser
fishEyeurl
StringrootModule
StringopenGrokurl
StringdepotPath
StringprojectName
Stringp4Weburl
Stringswarmurl
String$class: 'PlasticSCM'selector
StringworkspaceName
StringuseUpdate
booleanuseMultipleWorkspaces
booleanadditionalWorkspaces
selector
StringworkspaceName
StringuseUpdate
boolean$class: 'ProxySCM'projectName
String$class: 'PvcsScm'projectRoot
StringarchiveRoot
StringchangeLogPrefixFudge
StringmoduleDir
StringloginId
StringpvcsWorkspace
StringpromotionGroup
StringversionLabel
StringcleanCopy
boolean$class: 'RTCScm'overrideGlobal
The build toolkit location and Jazz Repository connection can be defined globally or overridden. If not defined globally, it must be overridden.
booleanbuildTool
The RTC build toolkit to use when performing builds. The toolkits available are defined in the system configuration (with the other tools like Ant and Java). The build toolkit is also necessary on the Master for polling and validating the job configuration unless the "Avoid using build toolkit on Master" option is enabled.
StringserverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
Stringtimeout
The timeout period in seconds for Jazz repository requests made during the build.
intuserId
The build user id. Either credentials or a user id and password information should be supplied.
Stringpassword
The Jazz Repository password for the build user. The use of a password is not secure, it can be easily discovered by anyone with access to this page. Credentials, a password file or a password should be supplied.
hudson.util.Secret
passwordFile
The path to the file containing the obfuscated Jazz Repository password for the build user. Credentials, a password file or a password should be supplied.
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringbuildType
value
StringbuildDefinition
StringbuildWorkspace
StringbuildSnapshot
StringbuildStream
StringacceptBeforeLoad (optional)
booleanaddLinksToWorkItems (optional)
booleanbuildSnapshotContext (optional)
snapshotOwnerType
StringprocessAreaOfOwningStream
StringowningStream
StringowningWorkspace
StringclearLoadDirectory (optional)
booleancomponentLoadConfig (optional)
StringcomponentsToExclude (optional)
StringcreateFoldersForComponents (optional)
booleancurrentSnapshotOwnerType (optional)
StringcustomizedSnapshotName (optional)
StringgenerateChangelogWithGoodBuild (optional)
booleanloadDirectory (optional)
StringloadPolicy (optional)
StringoverrideDefaultSnapshotName (optional)
booleanpathToLoadRuleFile (optional)
StringprocessArea (optional)
StringuseDynamicLoadRules (optional)
booleanavoidUsingToolkit
Where possible avoid using the Build toolkit when performing tasks on the Master. This is still in the experimental stage. You will require an RTC 5.0 server which provides some of the services used.
The Build toolkit will not be used when polling RTC and terminating the RTC Build. The toolkit is still required though. It is used for other configuration tasks on the Master (i.e. validating the connection to RTC, the build definition or workspace). It is also used for checkout tasks typically performed on slave nodes.
boolean$class: 'SCLMSCM'server
Stringport
intcredentialsId
StringJESINTERFACELEVEL1
booleanproject
Stringalternate
Stringgroup
Stringtypes
StringcustJobStep
booleanJobStep
StringcustJobHeader
booleanJobHeader
String$class: 'ShellScriptSCM'checkoutShell
StringpollingShell
StringuseCheckoutForPolling
boolean$class: 'SimpleClearCaseSCM'loadRules
/vobs/structure/package/product/subproduct
/vobs/structure/package/product/anothersubproduct.
Stringviewname
Stringbranch
Stringfilter
boolean$class: 'StarTeamSCM'hostname
Stringport
intprojectname
Stringviewname
Stringfoldername
Stringusername
Stringpassword
Stringlabelname
Stringpromotionstate
boolean$class: 'StoreSCM'scriptName
StringrepositoryName
Stringpundles
pundleType
PACKAGE, BUNDLEname
StringversionRegex
StringminimumBlessingLevel
StringgenerateParcelBuilderInputFile
booleanparcelBuilderInputFilename
String$class: 'SubversionSCM'locations
remote
StringcredentialsId
Stringlocal
.) may be used to check out the project directly into the workspace rather than into a subdirectory.
StringdepthOption
StringignoreExternalsOption
svn:externals to gain read access to the entire Subversion repository. This can happen if you follow the normal practice of giving Jenkins credentials with read access to the entire Subversion repository. You will also need to provide the credentials to use when checking/polling out the svn:externals using the
Additional Credentials option.
booleancancelProcessOnExternalsFail
booleanworkspaceUpdater
$class: 'CheckoutUpdater'$class: 'NoopUpdater'$class: 'UpdateUpdater'$class: 'UpdateWithCleanUpdater'$class: 'UpdateWithRevertUpdater'browser
$class: 'Assembla'spaceName
String$class: 'BacklogRepositoryBrowser'url
When no value is set, project of "Backlog URL" set above is used.
String$class: 'CollabNetSVN'url
String$class: 'FishEyeSVN'url
StringrootModule
String$class: 'Phabricator'url
Stringrepo
String$class: 'PolarionRepositoryBrowser'url
Stringlocation
String$class: 'RedmineRepositoryBrowser'repositoryId
String$class: 'SVNWeb'url
String$class: 'Sventon'url
StringrepositoryInstance
String$class: 'Sventon2'url
StringrepositoryInstance
String$class: 'TeamForge'connectionFactory
url
This should be the URL of your CollabNet TeamForge site. It should be of the form 'https://forge.collab.net'.
Stringusername
The user who will upload the files.
Stringpassword
The password for the user specified above. If incorrectly given, the login to the CollabNet TeamForge server will fail.
Stringproject
Stringrepo
String$class: 'TracRepositoryBrowser'$class: 'ViewSVN'url
String$class: 'ViewVCRepositoryBrowser'url
Stringlocation
String$class: 'VisualSVN'url
String$class: 'WebSVN'url
StringexcludedRegions
/trunk/myapp/src/main/web/.*\.html /trunk/myapp/src/main/web/.*\.jpeg /trunk/myapp/src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
StringexcludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
StringexcludedRevprop
StringexcludedCommitMessages
StringincludedRegions
/trunk/myapp/c/library1/.* /trunk/myapp/c/library2/.*If /trunk/myapp is checked out, the build will only occur when there are changes to either the c/library1 and c/library2 subtrees. If there are also excluded regions specified, then a file is not ignored when it is in the included list and not in the excluded list. More information on regular expressions can be found here.
StringignoreDirPropChanges
booleanfilterChangelog
booleanadditionalCredentials
If there are additional credentials required in order to obtain a complete checkout of the source, they can be provided here.
The realm is how the repository self-identifies to a client. It usually has the following format:
<proto://host:port> Realm Name
proto is the protocol, e.g. http or svn.host is the host how it's accessed by Jenkins, e.g. as IP address 192.168.1.100, host name svnserver, or host name and domain svn.example.org.port is the port, even if not explicitly specified. By default, this is 80 for HTTP, 443 for HTTPS, 3690 for the svn protocol.Realm Name is how the repository self-identifies. Common options include VisualSVN Server, Subversion Authentication or the UUID of the repository.To find out the realm, you could do any of the following:
Realm Name (see above) in the authentication dialog.svn program.
svn info https://svnserver/repo and it will tell you the realm when asking you to enter a password, e.g.: Authentication realm: <svn://svnserver:3690> VisualSVN Server.~/.subversion/auth/svn/simple; it will be two lines below the line svn:realmstring.svn+ssh protocol, the realm has the format username@svn+ssh://host:port – note that the username is before the svn+ssh:// (unlike the URL used for normal SVN operations), and that there are no angle brackets and no realm name. For this protocol the default port is 22.Make sure to enter the realm exactly as shown, starting with a < (except for repositories accessed via svn+ssh – see above).
realm
<scheme://hostname(:port)> name, while for servers accessed via
svn+ssh it is of the format
(username@)svn+ssh://hostname(:port).
StringcredentialsId
StringquietOperation
Mimics subversion command line --quiet parameter for check out / update operations to help keep the output shorter. Prints nothing, or only summary information.
boolean$class: 'SurroundSCM'server
StringserverPort
Stringbranch
Stringrepository
StringcredentialsId
StringrsaKey (optional)
rsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyType (optional)
NoKey, Path, IDrsaKeyValue (optional)
StringrsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyPath (optional)
String$class: 'SynergySCM'project
Stringdatabase
Stringrelease
Stringpurpose
Stringusername
Stringpassword
Stringengine
StringoldProject
Stringbaseline
StringoldBaseline
StringccmHome
StringremoteClient
booleandetectConflict
booleanreplaceSubprojects
booleancheckForUpdateWarnings
booleanleaveSessionOpen
booleanmaintainWorkarea
booleancheckTaskModifiedObjects
boolean$class: 'TeamFoundationServerScm'serverUrl
/DefaultCollection.
http://tfs.example.com:8080/tfs/DefaultCollectionhttps://tfs.example.com:8080/tfs/CustomCollectionhttps://fabrikam-fiber-inc.visualstudio.comHistorically, this field was labeled "Server URL" because earlier versions of TFS did not support team project collections.
StringprojectPath
The name of the project as it is registered on the server.
StringworkspaceName
The name of the Workspace under which the source should be retrieved. This workspace is created as needed. You can normally omit the property unless you want to name a workspace to avoid conflicts on the server (i.e. when you have multiple projects on one server talking to TFS/Team Services)
The default value is to create a workspace named Hudson-${JOB_NAME}. The TFS plugin for Jenkins supports the following macros that are replaced in the workspace name:
StringuserName
Stringpassword
hudson.util.Secret
cloakedPaths (optional)
Paths that are cloaked will not be pulled into the local workspace during a GET from the TFVC repository.
Check-ins that contain files only in cloaked folders (in other words, fully cloaked) will not trigger a build, whereas a check-in containing any path that isn't cloaked will trigger a build.
For example, suppose the Project path is $/Example/project/path, and the repository contains the following subfolders:
$/Example/project/path/ANow, suppose the following paths were entered as Cloaked Paths:
$/Example/project/path/A/1
$/Example/project/path/A/2
$/Example/project/path/B
$/Example/project/path/C
$/Example/project/path/A/2...then the resulting workspace on the Jenkins server would only have the following folders:
$/Example/project/path/B
$/Example/project/path/A
$/Example/project/path/A/1
$/Example/project/path/C
To continue with the example, the following check-in will not trigger a build, because it only contains changes under cloaked paths:
$/Example/project/path/A/2/alpha.txt...whereas this check-in will trigger a build, because it contains at least one path that isn't cloaked:
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
$/Example/project/path/A/1/first.txt
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
StringcredentialsConfigurer (optional)
$class: 'AutomaticCredentialsConfigurer'$class: 'ManualCredentialsConfigurer'userName
The name of the user that will be connecting to TFS/Team Services to query history, checkout files, etc.
For [on-premises] Team Foundation Server, the user name can be specified in two ways:
For Team Services, there are also two options:
Stringpassword
hudson.util.Secret
localPath (optional)
The folder where all files will be retrieved into. The folder name is a relative path, under the workspace of the current job.
The default setting is to retrieve the files into the workspace (ie. the workfolder is ".".
StringuseOverwrite (optional)
booleanuseUpdate (optional)
booleanversionSpec (optional)
String$class: 'VaultSCM'serverName
Stringpath
StringuserName
Stringpassword
StringrepositoryName
StringvaultName
StringsslEnabled
booleanuseNonWorkingFolder
booleanmerge
StringfileTime
StringmakeWritableEnabled
booleanverboseEnabled
boolean$class: 'hudson.plugins.gradle_repo.RepoScm'repositoryUrl
Stringbranch
String$class: 'hudson.plugins.repo.RepoScm'manifestRepositoryUrl
StringcurrentBranch (optional)
booleandepth (optional)
intdestinationDir (optional)
StringforceSync (optional)
booleanignoreProjects (optional)
Stringjobs (optional)
intlocalManifest (optional)
StringmanifestBranch (optional)
StringmanifestFile (optional)
StringmanifestGroup (optional)
StringmirrorDir (optional)
StringnoTags (optional)
booleanquiet (optional)
booleanrepoUrl (optional)
StringresetFirst (optional)
booleanshowAllChanges (optional)
booleantrace (optional)
boolean$class: 'OpenShiftImageStreams'imageStreamName
Stringtag
StringapiURL
Stringnamespace
StringauthToken
Stringverbose
String$class: 'PdsConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
String$class: 'PerforceSCM'p4User
Stringp4Passwd
Stringp4Client
Stringp4Port
StringprojectOptions
Stringp4Tool
Stringp4SysRoot
Stringp4SysDrive
Stringp4Label
Stringp4Counter
Stringp4UpstreamProject
StringlineEndValue
Stringp4Charset
Stringp4CommandCharset
StringclientOwner
StringupdateCounterValue
booleanforceSync
booleandontUpdateServer
booleanalwaysForceSync
booleancreateWorkspace
booleanupdateView
booleandisableChangeLogOnly
booleandisableSyncOnly
booleanshowIntegChanges
booleandontUpdateClient
booleanexposeP4Passwd
booleanpollOnlyOnMaster
booleanslaveClientNameFormat
StringfirstChange
intfileLimit
intbrowser
$class: 'FishEyePerforce'url
StringrootModule
String$class: 'P4Web'url
String$class: 'Perfbrowse'url
StringexcludedUsers
StringexcludedFiles
StringexcludedFilesCaseSensitivity
booleandepotType
value
Stringp4Stream
StringclientSpec
StringprojectPath
StringcleanWorkspace
cleanType
value
StringrestoreChangedDeletedFiles
booleanwipeRepoBeforeBuild
booleanuseViewMask
viewMask
StringuseViewMaskForPolling
booleanuseViewMaskForSyncing
booleanuseViewMaskForChangeLog
booleanperforcecredential
Select the appropriate credential for the Perforce connection. Perforce Credentials are defined in the Jenkins Credentials plugin here.
There are two types:
Stringworkspace
Select the appropriate Perforce workspace behaviour from the list. Not all modes will suit all Jenkins Job build types.
There are five types:
manualSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
Stringspec
allwrite
booleanclobber
booleancompress
booleanlocked
booleanmodtime
booleanrmdir
booleanstreamName
Stringline
Set line-ending character(s) for client text files.
linefeed: UNIX style.
carriage return: Macintosh style. (obsolete)
carriage return-linefeed: Windows style.
hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
Stringview
Lines to map depot files into the client workspace.
Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
StringchangeView
Stringtype
Type of client: writeable/readonly/partitioned/graph
By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
StringserverID
Stringbackup
Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
booleancleanup
booleansyncID (optional)
StringspecFileSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
StringspecPath
StringsyncID (optional)
StringstaticSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
StringsyncID (optional)
StringstreamSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanstreamName
Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
For example: //stream-depot/main-streamStringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
StringtemplateSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleantemplateName
Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
Stringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
Stringfilter
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringpopulate
Perforce will populate the workspace with the file revisions needed for the build. The different options effect the way the workspace is cleaned and the file revisions are updated.
There are three options:
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringbrowser
fishEyeurl
StringrootModule
StringopenGrokurl
StringdepotPath
StringprojectName
Stringp4Weburl
Stringswarmurl
String$class: 'PlasticSCM'selector
StringworkspaceName
StringuseUpdate
booleanuseMultipleWorkspaces
booleanadditionalWorkspaces
selector
StringworkspaceName
StringuseUpdate
boolean$class: 'ProxySCM'projectName
String$class: 'PvcsScm'projectRoot
StringarchiveRoot
StringchangeLogPrefixFudge
StringmoduleDir
StringloginId
StringpvcsWorkspace
StringpromotionGroup
StringversionLabel
StringcleanCopy
boolean$class: 'RTCScm'overrideGlobal
The build toolkit location and Jazz Repository connection can be defined globally or overridden. If not defined globally, it must be overridden.
booleanbuildTool
The RTC build toolkit to use when performing builds. The toolkits available are defined in the system configuration (with the other tools like Ant and Java). The build toolkit is also necessary on the Master for polling and validating the job configuration unless the "Avoid using build toolkit on Master" option is enabled.
StringserverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
Stringtimeout
The timeout period in seconds for Jazz repository requests made during the build.
intuserId
The build user id. Either credentials or a user id and password information should be supplied.
Stringpassword
The Jazz Repository password for the build user. The use of a password is not secure, it can be easily discovered by anyone with access to this page. Credentials, a password file or a password should be supplied.
hudson.util.Secret
passwordFile
The path to the file containing the obfuscated Jazz Repository password for the build user. Credentials, a password file or a password should be supplied.
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringbuildType
value
StringbuildDefinition
StringbuildWorkspace
StringbuildSnapshot
StringbuildStream
StringacceptBeforeLoad (optional)
booleanaddLinksToWorkItems (optional)
booleanbuildSnapshotContext (optional)
snapshotOwnerType
StringprocessAreaOfOwningStream
StringowningStream
StringowningWorkspace
StringclearLoadDirectory (optional)
booleancomponentLoadConfig (optional)
StringcomponentsToExclude (optional)
StringcreateFoldersForComponents (optional)
booleancurrentSnapshotOwnerType (optional)
StringcustomizedSnapshotName (optional)
StringgenerateChangelogWithGoodBuild (optional)
booleanloadDirectory (optional)
StringloadPolicy (optional)
StringoverrideDefaultSnapshotName (optional)
booleanpathToLoadRuleFile (optional)
StringprocessArea (optional)
StringuseDynamicLoadRules (optional)
booleanavoidUsingToolkit
Where possible avoid using the Build toolkit when performing tasks on the Master. This is still in the experimental stage. You will require an RTC 5.0 server which provides some of the services used.
The Build toolkit will not be used when polling RTC and terminating the RTC Build. The toolkit is still required though. It is used for other configuration tasks on the Master (i.e. validating the connection to RTC, the build definition or workspace). It is also used for checkout tasks typically performed on slave nodes.
boolean$class: 'SCLMSCM'server
Stringport
intcredentialsId
StringJESINTERFACELEVEL1
booleanproject
Stringalternate
Stringgroup
Stringtypes
StringcustJobStep
booleanJobStep
StringcustJobHeader
booleanJobHeader
String$class: 'ShellScriptSCM'checkoutShell
StringpollingShell
StringuseCheckoutForPolling
boolean$class: 'SimpleClearCaseSCM'loadRules
/vobs/structure/package/product/subproduct
/vobs/structure/package/product/anothersubproduct.
Stringviewname
Stringbranch
Stringfilter
boolean$class: 'StarTeamSCM'hostname
Stringport
intprojectname
Stringviewname
Stringfoldername
Stringusername
Stringpassword
Stringlabelname
Stringpromotionstate
boolean$class: 'StoreSCM'scriptName
StringrepositoryName
Stringpundles
pundleType
PACKAGE, BUNDLEname
StringversionRegex
StringminimumBlessingLevel
StringgenerateParcelBuilderInputFile
booleanparcelBuilderInputFilename
String$class: 'SubversionSCM'locations
remote
StringcredentialsId
Stringlocal
.) may be used to check out the project directly into the workspace rather than into a subdirectory.
StringdepthOption
StringignoreExternalsOption
svn:externals to gain read access to the entire Subversion repository. This can happen if you follow the normal practice of giving Jenkins credentials with read access to the entire Subversion repository. You will also need to provide the credentials to use when checking/polling out the svn:externals using the
Additional Credentials option.
booleancancelProcessOnExternalsFail
booleanworkspaceUpdater
$class: 'CheckoutUpdater'$class: 'NoopUpdater'$class: 'UpdateUpdater'$class: 'UpdateWithCleanUpdater'$class: 'UpdateWithRevertUpdater'browser
$class: 'Assembla'spaceName
String$class: 'BacklogRepositoryBrowser'url
When no value is set, project of "Backlog URL" set above is used.
String$class: 'CollabNetSVN'url
String$class: 'FishEyeSVN'url
StringrootModule
String$class: 'Phabricator'url
Stringrepo
String$class: 'PolarionRepositoryBrowser'url
Stringlocation
String$class: 'RedmineRepositoryBrowser'repositoryId
String$class: 'SVNWeb'url
String$class: 'Sventon'url
StringrepositoryInstance
String$class: 'Sventon2'url
StringrepositoryInstance
String$class: 'TeamForge'connectionFactory
url
This should be the URL of your CollabNet TeamForge site. It should be of the form 'https://forge.collab.net'.
Stringusername
The user who will upload the files.
Stringpassword
The password for the user specified above. If incorrectly given, the login to the CollabNet TeamForge server will fail.
Stringproject
Stringrepo
String$class: 'TracRepositoryBrowser'$class: 'ViewSVN'url
String$class: 'ViewVCRepositoryBrowser'url
Stringlocation
String$class: 'VisualSVN'url
String$class: 'WebSVN'url
StringexcludedRegions
/trunk/myapp/src/main/web/.*\.html /trunk/myapp/src/main/web/.*\.jpeg /trunk/myapp/src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
StringexcludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
StringexcludedRevprop
StringexcludedCommitMessages
StringincludedRegions
/trunk/myapp/c/library1/.* /trunk/myapp/c/library2/.*If /trunk/myapp is checked out, the build will only occur when there are changes to either the c/library1 and c/library2 subtrees. If there are also excluded regions specified, then a file is not ignored when it is in the included list and not in the excluded list. More information on regular expressions can be found here.
StringignoreDirPropChanges
booleanfilterChangelog
booleanadditionalCredentials
If there are additional credentials required in order to obtain a complete checkout of the source, they can be provided here.
The realm is how the repository self-identifies to a client. It usually has the following format:
<proto://host:port> Realm Name
proto is the protocol, e.g. http or svn.host is the host how it's accessed by Jenkins, e.g. as IP address 192.168.1.100, host name svnserver, or host name and domain svn.example.org.port is the port, even if not explicitly specified. By default, this is 80 for HTTP, 443 for HTTPS, 3690 for the svn protocol.Realm Name is how the repository self-identifies. Common options include VisualSVN Server, Subversion Authentication or the UUID of the repository.To find out the realm, you could do any of the following:
Realm Name (see above) in the authentication dialog.svn program.
svn info https://svnserver/repo and it will tell you the realm when asking you to enter a password, e.g.: Authentication realm: <svn://svnserver:3690> VisualSVN Server.~/.subversion/auth/svn/simple; it will be two lines below the line svn:realmstring.svn+ssh protocol, the realm has the format username@svn+ssh://host:port – note that the username is before the svn+ssh:// (unlike the URL used for normal SVN operations), and that there are no angle brackets and no realm name. For this protocol the default port is 22.Make sure to enter the realm exactly as shown, starting with a < (except for repositories accessed via svn+ssh – see above).
realm
<scheme://hostname(:port)> name, while for servers accessed via
svn+ssh it is of the format
(username@)svn+ssh://hostname(:port).
StringcredentialsId
StringquietOperation
Mimics subversion command line --quiet parameter for check out / update operations to help keep the output shorter. Prints nothing, or only summary information.
boolean$class: 'SurroundSCM'server
StringserverPort
Stringbranch
Stringrepository
StringcredentialsId
StringrsaKey (optional)
rsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyType (optional)
NoKey, Path, IDrsaKeyValue (optional)
StringrsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyPath (optional)
String$class: 'SynergySCM'project
Stringdatabase
Stringrelease
Stringpurpose
Stringusername
Stringpassword
Stringengine
StringoldProject
Stringbaseline
StringoldBaseline
StringccmHome
StringremoteClient
booleandetectConflict
booleanreplaceSubprojects
booleancheckForUpdateWarnings
booleanleaveSessionOpen
booleanmaintainWorkarea
booleancheckTaskModifiedObjects
boolean$class: 'TeamFoundationServerScm'serverUrl
/DefaultCollection.
http://tfs.example.com:8080/tfs/DefaultCollectionhttps://tfs.example.com:8080/tfs/CustomCollectionhttps://fabrikam-fiber-inc.visualstudio.comHistorically, this field was labeled "Server URL" because earlier versions of TFS did not support team project collections.
StringprojectPath
The name of the project as it is registered on the server.
StringworkspaceName
The name of the Workspace under which the source should be retrieved. This workspace is created as needed. You can normally omit the property unless you want to name a workspace to avoid conflicts on the server (i.e. when you have multiple projects on one server talking to TFS/Team Services)
The default value is to create a workspace named Hudson-${JOB_NAME}. The TFS plugin for Jenkins supports the following macros that are replaced in the workspace name:
StringuserName
Stringpassword
hudson.util.Secret
cloakedPaths (optional)
Paths that are cloaked will not be pulled into the local workspace during a GET from the TFVC repository.
Check-ins that contain files only in cloaked folders (in other words, fully cloaked) will not trigger a build, whereas a check-in containing any path that isn't cloaked will trigger a build.
For example, suppose the Project path is $/Example/project/path, and the repository contains the following subfolders:
$/Example/project/path/ANow, suppose the following paths were entered as Cloaked Paths:
$/Example/project/path/A/1
$/Example/project/path/A/2
$/Example/project/path/B
$/Example/project/path/C
$/Example/project/path/A/2...then the resulting workspace on the Jenkins server would only have the following folders:
$/Example/project/path/B
$/Example/project/path/A
$/Example/project/path/A/1
$/Example/project/path/C
To continue with the example, the following check-in will not trigger a build, because it only contains changes under cloaked paths:
$/Example/project/path/A/2/alpha.txt...whereas this check-in will trigger a build, because it contains at least one path that isn't cloaked:
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
$/Example/project/path/A/1/first.txt
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
StringcredentialsConfigurer (optional)
$class: 'AutomaticCredentialsConfigurer'$class: 'ManualCredentialsConfigurer'userName
The name of the user that will be connecting to TFS/Team Services to query history, checkout files, etc.
For [on-premises] Team Foundation Server, the user name can be specified in two ways:
For Team Services, there are also two options:
Stringpassword
hudson.util.Secret
localPath (optional)
The folder where all files will be retrieved into. The folder name is a relative path, under the workspace of the current job.
The default setting is to retrieve the files into the workspace (ie. the workfolder is ".".
StringuseOverwrite (optional)
booleanuseUpdate (optional)
booleanversionSpec (optional)
String$class: 'VaultSCM'serverName
Stringpath
StringuserName
Stringpassword
StringrepositoryName
StringvaultName
StringsslEnabled
booleanuseNonWorkingFolder
booleanmerge
StringfileTime
StringmakeWritableEnabled
booleanverboseEnabled
boolean$class: 'hudson.plugins.gradle_repo.RepoScm'repositoryUrl
Stringbranch
String$class: 'hudson.plugins.repo.RepoScm'manifestRepositoryUrl
StringcurrentBranch (optional)
booleandepth (optional)
intdestinationDir (optional)
StringforceSync (optional)
booleanignoreProjects (optional)
Stringjobs (optional)
intlocalManifest (optional)
StringmanifestBranch (optional)
StringmanifestFile (optional)
StringmanifestGroup (optional)
StringmirrorDir (optional)
StringnoTags (optional)
booleanquiet (optional)
booleanrepoUrl (optional)
StringresetFirst (optional)
booleanshowAllChanges (optional)
booleantrace (optional)
booleanlabels
String$class: 'JiraReleaseVersionUpdaterBuilder'jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in JIRA.
(EXAMPLE-100)
StringjiraRelease
StringjiraDescription
String$class: 'JiraVersionCreatorBuilder'jiraVersion
StringjiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in JIRA.
(EXAMPLE-100)
String$class: 'JobConfigRebrander'$class: 'KarafBuildStepBuilder'useCustomKaraf
booleankarafHome
Stringflags
specify the port to connect to
-h [host]specify the host to connect to
-u [user]specify the user name
-p [password]specify the password (optional, if not provided, the password is prompted)
-vraise verbosity
-lset client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]retry connection establishment (up to attempts times)
-d [delay]intra-retry delay (defaults to 2 seconds)
-f [file]read commands from the specified file
-k [keyFile]specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]define the client idle timeout
Stringoption
$class: 'KarafCommandFileOption'file
String$class: 'KarafCommandScriptOption'script (optional)
StringunlockMacOSKeychainkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
hudson.util.Secret
$class: 'KlocworkBuildSpecBuilder'buildSpecConfig
buildCommand
Stringtool
Stringoutput
StringadditionalOpts
StringignoreErrors
boolean$class: 'KlocworkCiBuilder'ciConfig
buildSpec
StringprojectDir
StringcleanupProject
booleanreportFile
StringadditionalOpts
StringincrementalAnalysis
This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit like behaviour. The idea is that only changed files are analysed using the Klocwork kwciagent tool to replicate the analysis developers would perform using Visual Studio, Eclipse or the command line utility. To enable this the plugin takes a list of the changed files from the SCM, this enables the ability to analyse only the changed files when the workspace isn’t kept. Leave this unticked to analyse the whole project or if the workspace is kept then a standard incremental analysis.
The diff file list is the file to contain the changed source files that Klocwork should analyse. It is required that any analysed files should exist in the build specification generated by kwinject
IMPORTANT: It is required that any files to be analysed must also exist in the build specification specified
If using Git, please provide the previous commit that Git should perform a "diff" with. The change list between the current commit and the specified previous commit will then be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build.
If you are not using Git, or want to manually generate the change list using Git, then please select this option. You will need to generate the diff file list with a custom build-step (or similar). Future support for more SCM tools (such as SVN, perforce) may be added depending on demand. The format of the file should be a changed source file per line
Future support for more SCM tools (such as SVN, perforce) may be added depending on demand.
booleandiffAnalysisConfig
diffType
StringgitPreviousCommit
StringdiffFileList
StringciTool
String$class: 'KlocworkGatewayPublisher'gatewayConfig
enableServerGateway (optional)
Create multiple gateways using queries that are sent to the Klocwork server using the web api.
Filter issues based on the search query, then provide the status to set the build to, along with the threshold (number of issues to meet this criteria)
Note: unless specified the query will run with issue grouping turned off (grouping:off)
booleangatewayServerConfigs (optional)
jobResult
Stringquery
Stringthreshold
StringconditionName
StringstopBuild
booleanenableHTMLReporting
booleanenableCiGateway (optional)
booleanenableDesktopGateway (optional)
Set a threshold for the incremental diff analsysis gateway. Pass the build if threshold not exceeded, fail otherwise.
This checks the XML report generated by the incremental diff analysis build-step. You can filter which issues appear in this report by providing additional options to the incremental diff analysis build-step.
This gateway simply counts the total number of issues in the XML report.
booleangatewayCiConfig (optional)
threshold (optional)
StringreportFile (optional)
StringenableHTMLReporting (optional)
booleanenabledSeverites (optional)
critical
booleanerror
booleanwarning
booleanreview
booleanfiveToTen
booleanenabledStatuses (optional)
analyze
booleanignore
booleannotAProblem
booleanfix
booleanfixInNextRelease
booleanfixInLaterRelease
booleandefer
booleanfilter
booleanfailUnstable (optional)
booleanname (optional)
StringstopBuild (optional)
booleangatewayCiConfigs (optional)
threshold (optional)
StringreportFile (optional)
StringenableHTMLReporting (optional)
booleanenabledSeverites (optional)
critical
booleanerror
booleanwarning
booleanreview
booleanfiveToTen
booleanenabledStatuses (optional)
analyze
booleanignore
booleannotAProblem
booleanfix
booleanfixInNextRelease
booleanfixInLaterRelease
booleandefer
booleanfilter
booleanfailUnstable (optional)
booleanname (optional)
StringstopBuild (optional)
booleangatewayDesktopConfig (optional)
threshold (optional)
StringreportFile (optional)
StringenableHTMLReporting (optional)
booleanenabledSeverites (optional)
critical
booleanerror
booleanwarning
booleanreview
booleanfiveToTen
booleanenabledStatuses (optional)
analyze
booleanignore
booleannotAProblem
booleanfix
booleanfixInNextRelease
booleanfixInLaterRelease
booleandefer
booleanfilter
booleanfailUnstable (optional)
booleanname (optional)
StringstopBuild (optional)
boolean$class: 'KlocworkServerAnalysisBuilder'serverConfig
buildSpec
StringtablesDir
StringincrementalAnalysis
booleanignoreCompileErrors
booleanimportConfig
StringadditionalOpts
StringdisableKwdeploy
boolean$class: 'KlocworkServerLoadBuilder'serverConfig (optional)
tablesDir (optional)
StringbuildName (optional)
StringadditionalOpts (optional)
StringreportConfig (optional)
displayChart (optional)
booleanchartHeight (optional)
StringchartWidth (optional)
Stringquery (optional)
String$class: 'KlocworkXSyncBuilder'syncConfig
dryRun
booleanlastSync
StringprojectRegexp
StringstatusAnalyze
booleanstatusIgnore
booleanstatusNotAProblem
booleanstatusFix
booleanstatusFixInNextRelease
booleanstatusFixInLaterRelease
booleanstatusDefer
booleanstatusFilter
booleanadditionalOpts
String$class: 'KubernetesDeploy'context
configs (optional)
The path patterns for the Kubernetes configurations you want to deploy, in the form of Ant glob syntax.
StringcredentialsType (optional)
Choose how to get the kubeconfig file to authenticate with the Kubernetes cluster management endpoint.
3 options are supported:
~/.kube/config file through an SSH connection to the master node.See also: Configure kubectl
StringdockerCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringenableConfigSubstitution (optional)
Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleankubeConfig (optional)
path (optional)
kubeconfig file path relative to the current Jenkins workspace.
StringkubeconfigId (optional)
StringsecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g.,
some-secret-$BUILD_NUMBER. The name should be in the pattern
[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See
Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
Stringssh (optional)
sshCredentialsId (optional)
StringsshServer (optional)
<host>[:<port>]) of the Kubernetes master node. If port is omitted, the default SSH port 22 will be used.
StringtextCredentials (optional)
certificateAuthorityData (optional)
clusters.cluster.certificate-authority-data value in the
kubeconfig file.
StringclientCertificateData (optional)
users.user.client-certificate-data value in the
kubeconfig file.
StringclientKeyData (optional)
users.user.client-key-data value in the
kubeconfig file.
StringserverUrl (optional)
clusters.cluster.server address in the
kubeconfig. Generally, it should start with
https://.
StringkubernetesEngineDeploycluster (optional)
StringclusterName (optional)
StringcredentialsId (optional)
Stringlocation (optional)
StringmanifestPattern (optional)
Stringnamespace (optional)
StringprojectId (optional)
StringverboseLogging (optional)
booleanverifyDeployments (optional)
booleanverifyServices (optional)
booleanverifyTimeoutInMinutes (optional)
intzone (optional)
Stringloadcompletetestproject (optional)
Stringtest (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleangeneratePDF (optional)
booleantimeout (optional)
StringuseTimeout (optional)
boolean$class: 'LabeledTestResultGroupPublisher'configs
parserClassName
StringtestResultFileMask
Stringlabel
StringeventSourceLambdalambdaEventSourceBuildStepVariables
awsRegion
StringfunctionName
StringeventSourceArn
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringfunctionAlias (optional)
StringuseInstanceCredentials (optional)
booleaninvokeLambdalambdaInvokeBuildStepVariables
awsRegion
StringfunctionName
Stringsynchronous
booleanawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringjsonParameters (optional)
envVarName
StringjsonPath (optional)
Stringpayload (optional)
StringuseInstanceCredentials (optional)
booleanpublishLambdalambdaPublishBuildStepVariables
awsRegion
StringfunctionARN
StringfunctionAlias
StringversionDescription
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringuseInstanceCredentials (optional)
booleandeployLambdalambdaUploadBuildStepVariables
awsRegion
StringfunctionName
StringupdateMode
Stringalias (optional)
StringartifactLocation (optional)
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringcreateAlias (optional)
booleandeadLetterQueueArn (optional)
Stringdescription (optional)
StringenableDeadLetterQueue (optional)
booleanenvironmentConfiguration (optional)
environment
key
Stringvalue
StringconfigureEnvironment (optional)
booleankmsArn (optional)
Stringhandler (optional)
StringmemorySize (optional)
Stringpublish (optional)
booleanrole (optional)
Stringruntime (optional)
StringsecurityGroups (optional)
Stringsubnets (optional)
Stringtimeout (optional)
StringuseInstanceCredentials (optional)
booleanlastChangesShows build last changes via rich VCS diff between revisions using Diff2Html.
This plugin expects a .git or .svn folder on your job workspace.
After job execution the plugin will generate a html diff from current and a previous revision.
Note that the previous revision can be:
A provided revision id;
Revision of Last successful build;
Revision of anspecific build;
Revision of Last tag;
|
|
By default previous revision is current revision -1. |
|
|
You can use parameters in SpecificRevision. In case of git, expressions like HEAD^^ can be used. |
To get most from this plugin use periodically SCM pooling to Trigger your Build, more details here.
since (optional)
PREVIOUS_REVISION, LAST_SUCCESSFUL_BUILD, LAST_TAGformat (optional)
LINE, SIDEmatching (optional)
NONE, LINE, WORDshowFiles (optional)
booleansynchronisedScroll (optional)
booleanmatchWordsThreshold (optional)
StringmatchingMaxComparisons (optional)
StringspecificRevision (optional)
StringvcsDir (optional)
StringspecificBuild (optional)
String$class: 'LedBorgPublisher'failureState
StringsuccessState
StringunstableState
StringnotBuiltState
StringabortedState
String$class: 'LifxNotifier'notifyInProgress
colorInProgress
StringgroupColorSuccess
StringgroupColorFailure
StringcolorSuccess
StringcolorFailure
StringcolorSuccessCustom
StringcolorFailureCustom
String$class: 'LoadNinjaBuilder'apiKey
StringscenarioId
Stringoeb
errorPassCriteria
Stringodb
durationPassCriteria
String$class: 'LoadrunnerAnalysisRecorder'path
StringresultPath
Stringtemplate
StringtestSetId
int$class: 'LoadrunnerBuilder'path
StringtestPath
StringconnectQC
booleancredentials (optional)
Stringhost (optional)
StringqcDb (optional)
StringtestSetId (optional)
StringlogParseruseProjectRule
booleanprojectRulePath
StringparsingRulesPath
StringfailBuildOnError (optional)
booleanshowGraphs (optional)
booleanunstableOnWarning (optional)
boolean$class: 'LogstashNotifier'Send the tail of the log to Logstash.
maxLines
intfailBuild
booleanmstestfailOnError (optional)
booleankeepLongStdio (optional)
booleantestResultsFile (optional)
StringmablrestApiKey
StringenvironmentId
StringapplicationId
StringcontinueOnMablError (optional)
booleancontinueOnPlanFailure (optional)
booleandisableSslVerification (optional)
boolean$class: 'Mailer'recipients
StringnotifyEveryUnstableBuild
booleansendToIndividuals
If e-mail addresses are also specified in the recipient list, then both the individuals as well as the specified addresses get the notification e-mail. If the recipient list is empty, then only the individuals will receive e-mails.
boolean$class: 'MasterCoverageAction'jacocoCounterType (optional)
StringscmVars (optional)
java.lang.String>
$class: 'MatlabBuilder'localMatlab (optional)
StringtestRunTypeList (optional)
$class: 'RunTestsAutomaticallyOption'taCoberturaChkBx (optional)
booleantaJunitChkBx (optional)
booleantatapChkBx (optional)
boolean$class: 'RunTestsWithCustomCommandOption'customMatlabCommand (optional)
String$class: 'MavenInvokerRecorder'reportsFilenamePattern
This is a file name pattern that can be used to locate the Maven Invoker report files (for example **/target/invoker-reports/BUILD*.xml).
StringinvokerBuildDir
This is the directory where Maven Invoker runs. It is used to find the builds logs (for example **/target/its).
StringmavenSnapshotCheckcheck (optional)
booleanmemoryMapchosenParsers
gccParserparserUniqueName
A unique parser name. This has to be unique among the parsers chosen in this job otherwise results will get mixed together, renaming this invalidates previous results.
StringmapFile
An Ant file pattern, pointing to a map file, which describes the location of code in the specified memory layout
StringconfigurationFile
An Ant file pattern, pointing to a command file, which describes the memory layout of the target device
StringwordSize
intbytesOnGraph
booleangraphConfiguration
graphDataList
You can add several data values to one graph, with a comma separator, i.e DATA,CONST
This will create a graph with two datapoints
You can also ADD the values of the sections together like so: DATA+CONST this will generate one combined dataset with the combined value of CONST and DATA
StringgraphCaption
The title of the graph
StringparserTitle (optional)
StringtiParserparserUniqueName
A unique parser name. This has to be unique among the parsers chosen in this job otherwise results will get mixed together, renaming this invalidates previous results.
StringmapFile
An Ant file pattern, pointing to a map file, which describes the location of code in the specified memory layout
StringconfigurationFile
An Ant file pattern, pointing to a command file, which describes the memory layout of the target device
StringwordSize
intgraphConfiguration
graphDataList
You can add several data values to one graph, with a comma separator, i.e DATA,CONST
This will create a graph with two datapoints
You can also ADD the values of the sections together like so: DATA+CONST this will generate one combined dataset with the combined value of CONST and DATA
StringgraphCaption
The title of the graph
StringbytesOnGraph
booleanparserTitle (optional)
Stringscale (optional)
Scale for y-axis
StringshowBytesOnGraph (optional)
Show "Bytes" on y-axis rather than "Words"
booleanwordSize (optional)
The word size of the processor
Default value is 8
intredmineMetricsReportsettings (optional)
url
StringapiKey
Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
StringprojectName
Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
StringcustomQueryId
intsprintSize
Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.
int$class: 'MinioUploader'sourceFile
StringexcludedFile
StringbucketName
StringobjectNamePrefix
StringmisraReportdoFailOnError (optional)
booleandoFailOnIncompliance (optional)
booleangrpFile (optional)
A simple text file containing the guideline re-categorization plan (GRP) - see "MISRA Compliance 2016". Leave empty to not re-categorize any rules. Rules that are not recategorized do not need to appear in this listing.
The format of the text file should be:
[Guideline], [New compliance level]
Example:
Directive 1.1, Mandatory
Rule 11.2, Mandatory
Rule 12.1, Required
Rule 12.2, Disapplied
StringlogFile (optional)
StringnonMisraTagPattern (optional)
StringprojectName (optional)
StringruleSet (optional)
StringsoftwareVersion (optional)
StringsourceListFile (optional)
StringwarningParser (optional)
StringwarningsFile (optional)
String$class: 'MobileStudioTestBuilder'mobileStudioRunnerPath
StringtestPath
StringmsgServer (optional)
StringdeviceId (optional)
StringprojectRoot (optional)
StringtestAsUnit (optional)
booleanmoveComponentsnexusInstanceId
Stringdestination
Stringsearch (optional)
java.lang.String>
tagName (optional)
StringmqttNotificationbrokerUrl (optional)
The URL for the MQTT broker. This should also include the protocol (e.g. "tcp://192.168.0.1:1883").
Stringtopic (optional)
The topic to which to publish the notification. If no value is specified then the default value ("jenkins/$JOB_URL" e.g. "jenkins/job/my-build") is used.
In addition to environment variables and build parameters, the following variables can also be used (all variables must be prefix with "$"):
Stringmessage (optional)
The "payload" for the MQTT message.
In addition to environment variables and build parameters, the following variables can also be used (all variables must be encapsulated within "${}"):
Stringqos (optional)
StringretainMessage (optional)
If the message is "retained" then the broker will keep a copy as the "last known" message and publish it to any new subscribers when they first connect.
booleancredentialsId (optional)
StringapiKeyapiUrl (optional)
Stringgroup (optional)
StringbinaryName (optional)
Stringdescription (optional)
StringwaitForResults (optional)
booleanwaitMinutes (optional)
intbreakBuildOnScore (optional)
booleanscoreThreshold (optional)
intapiKey (optional)
StringuseBuildEndpoint (optional)
booleandebug (optional)
booleanpassword (optional)
StringproxyEnabled (optional)
booleanshowStatusMessages (optional)
booleanstopTestsForStatusMessage (optional)
Stringusername (optional)
StringnunittestResultsPattern (optional)
Stringdebug (optional)
booleanfailIfNoResults (optional)
booleanfailedTestsFailBuild (optional)
booleanhealthScaleFactor (optional)
1.0
0.0 will disable the test result contribution to build health score.0.1 means that 10% of tests failing will score 99% health0.5 means that 10% of tests failing will score 95% health1.0 means that 10% of tests failing will score 90% health2.0 means that 10% of tests failing will score 80% health2.5 means that 10% of tests failing will score 75% health5.0 means that 10% of tests failing will score 50% health10.0 means that 10% of tests failing will score 0% healthdoublekeepJUnitReports (optional)
booleanskipJUnitArchiver (optional)
booleanneuvectorrepository
StringregistrySelection
StringnameOfVulnerabilityToFailFour (optional)
StringnameOfVulnerabilityToFailOne (optional)
StringnameOfVulnerabilityToFailThree (optional)
StringnameOfVulnerabilityToFailTwo (optional)
StringnumberOfHighSeverityToFail (optional)
StringnumberOfMediumSeverityToFail (optional)
StringscanLayers (optional)
booleantag (optional)
String$class: 'NexusArtifactUploader'nexusVersion
Stringprotocol
StringnexusUrl
StringgroupId
Stringversion
Stringrepository
StringcredentialsId
Stringartifacts
artifactId
Stringtype
Stringclassifier
Stringfile
String$class: 'NexusPublisherBuildStep'nexusInstanceId
StringnexusRepositoryId
Stringpackages
$class: 'MavenPackage'mavenCoordinate
groupId
StringartifactId
Stringversion
Stringpackaging
StringmavenAssetList
filePath
Stringclassifier
Stringextension
StringtagName (optional)
Stringnirmatabuilder
Delete App in Environment
Deletes the specified application from the specified environment.
Deploy App in Environment
Deploys the specified application from catalog to specified application.
Update App in Catalog
Updates the specified application in specified catalog.
Update App in Environment
Updates the specified application in specified environment.
deleteAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdeployAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intcatalog
Stringdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringdeployType
StringupdateAppInCatalogendpoint
Stringapikey
Stringcatalog
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringupdateAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringaliyunOSSUploadendpoint
StringaccessKeyId
StringaccessKeySecret
StringbucketName
StringlocalPath
StringremotePath
StringmaxRetries
String$class: 'OctoperfBuilder'credentialsId
StringscenarioId
StringstopConditions (optional)
org.jenkinsci.plugins.octoperf.conditions.TestStopCondition
OneSkyprojectId (optional)
StringresourcesPath (optional)
String$class: 'OpenShiftBuildCanceller'apiURL
Stringnamespace
StringauthToken
Stringverbose
StringbldCfg
String$class: 'OpenShiftDeployCanceller'apiURL
StringdepCfg
Stringnamespace
StringauthToken
Stringverbose
String$class: 'OpenShiftScalerPostAction'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
StringuTesterPageCountTaskinitialUrl
StringurlsWhiteList
StringpageCount
intrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
intpangolinTestRailconfigs
testPath
Stringformat
StringresultPattern
StringfailIfUploadFailed
booleancustomProperties (optional)
StringtestRun (optional)
StringtestPlan (optional)
StringmilestonePath (optional)
StringcloseRun (optional)
booleancustomResultFields (optional)
StringcaseNameToIdMap (optional)
StringconfigurationNames (optional)
StringtestRailProject
StringtestRailUserName (optional)
StringtestRailPassword (optional)
String$class: 'PartialReleaseMgrSuccessfulBuilder'pcBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestId
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringpcGitBuilddescription
StringpcServerName
StringhttpsProtocol
booleancredentialsId
StringalmDomain
StringalmProject
StringserverAndPort
StringproxyOutURL
StringcredentialsProxyId
StringsubjectTestPlan
StringuploadScriptMode
RUNTIME_FILES, ALL_FILESremoveScriptFromPC
YES, NOimportTests
Note:
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the Performance Center project). If not specified, a Controller will be chosen from the different controllers available in the Performance Center project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the Performance Center project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the Performance Center root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
Duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
YES, NOpcRunBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestToRun
StringtestId
StringtestContentToCreate
The content of the field must either be:
Note:
| Parameter | Description | Required |
|---|---|---|
| test_name | The test name. | Yes |
| test_folder_path | The location of the test in the Test Management folder tree of the Performance Center project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the Performance Center root folder (named "Subject") | Yes |
| test_content | The content of the test that requires additional parameters specified in the 'test_content' table below. | Yes |
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the Performance Center project). If not specified, a Controller will be chosen from the different controllers available in the Performance Center project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the Performance Center project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the Performance Center root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from My PC -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
Stringperfpublishername
Stringthreshold
StringunstableThreshold
Stringhealthy
Stringunhealthy
Stringmetrics
StringparseAllMetrics
booleanactivateDTConfigurationdynatraceProfile
Stringconfiguration
StringcreateMemoryDumpdynatraceProfile
Stringagent
Stringhost
StringautoPostProcess (optional)
booleancapturePrimitives (optional)
booleancaptureStrings (optional)
booleandogc (optional)
booleanlockSession (optional)
booleantype (optional)
StringperfSigReportsdynatraceProfile
StringconfigurationTestCases
$class: 'GenericTestCase'name
StringsingleDashboards
dashboard
StringcomparisonDashboards
dashboard
StringxmlDashboard
StringclientDashboard (optional)
String$class: 'UnitTestCase'name
StringsingleDashboards
dashboard
StringcomparisonDashboards
dashboard
StringxmlDashboard
StringclientDashboard (optional)
StringdeleteSessions (optional)
booleanexportSessions (optional)
booleannonFunctionalFailure (optional)
intremoveConfidentialStrings (optional)
booleanstartSessiondynatraceProfile
StringtestCase
StringlockSession (optional)
booleanrecordingOption (optional)
StringstopSessiondynatraceProfile
StringcreateThreadDumpdynatraceProfile
Stringagent
Stringhost
StringlockSession (optional)
booleanblazeMeterTestcredentialsId (optional)
StringworkspaceId (optional)
StringtestId (optional)
StringabortJob (optional)
booleanadditionalTestFiles (optional)
StringgetJtl (optional)
booleangetJunit (optional)
booleanjobApiKey (optional)
StringjtlPath (optional)
StringjunitPath (optional)
StringmainTestFile (optional)
Stringnotes (optional)
StringreportLinkName (optional)
StringserverUrl (optional)
StringsessionProperties (optional)
StringperfReportsourceDataFiles
Specify the path to the Performance report files, relative to the workspace root. Plugin will be automatically detect parser for each report file.
Default Values are:
* By default jmeter writes summariser statistics to jmeter.log. To enable logging summariser statistics to separate log file add the property to jmeter.properties file to #Logging Configuration block : "log_file.jmeter.reporters.Summariser=filename.log"
** Default time format, that JMeter used for logging is "yyyy/mm/dd HH:mm:ss". See "log_format" property in jmeter.properties file in #Logging Configuration block.
*** By default wrk does not write output files. You'll need to redirect the STDOUT output for a file as in
wrk [options] [url] > results.wrk
StringbaselineBuild (optional)
intcompareBuildPrevious (optional)
booleanconfigType (optional)
Stringconstraints (optional)
hudson.plugins.performance.constraints.AbstractConstraint
errorFailedThreshold (optional)
interrorUnstableResponseTimeThreshold (optional)
Example: ------------------------------------- JMeterResultsOrders.jtl:2000 JMeterResultsGetCustomer.jtl:500 JMeterResultsCreateCustomer.jtl:700 -------------------------------------
StringerrorUnstableThreshold (optional)
intexcludeResponseTime (optional)
booleanfailBuildIfNoResultFile (optional)
booleanfilterRegex (optional)
If this field is not empty, its content will be considered as a regular expression to only take into account URI matching it.
Example : ^(HP|Scenario|Search)(-success|-failure)?$
StringgraphType (optional)
StringignoreFailedBuilds (optional)
booleanignoreUnstableBuilds (optional)
booleanjunitOutput (optional)
StringmodeEvaluation (optional)
Standard Mode activates upper box and ignores lower box.
Expert Mode activates lower box and ignores upper box.
booleanmodeOfThreshold (optional)
booleanmodePerformancePerTestCase (optional)
booleanmodeThroughput (optional)
booleannthBuildNumber (optional)
intparsers (optional)
$class: 'IagoParser'glob
Stringpercentiles
StringfilterRegex
String$class: 'JMeterCsvParser'glob
Stringpercentiles
StringfilterRegex
String$class: 'JMeterParser'glob
Stringpercentiles
StringfilterRegex
String$class: 'JUnitParser'glob
Stringpercentiles
StringfilterRegex
String$class: 'JmeterSummarizerParser'glob
Stringpercentiles
StringfilterRegex
String$class: 'LoadRunnerParser'glob
Stringpercentiles
StringfilterRegex
String$class: 'TaurusParser'glob
Stringpercentiles
StringfilterRegex
String$class: 'WrkSummarizerParser'glob
Stringpercentiles
StringfilterRegex
Stringpercentiles (optional)
StringpersistConstraintLog (optional)
booleanrelativeFailedThresholdNegative (optional)
doublerelativeFailedThresholdPositive (optional)
doublerelativeUnstableThresholdNegative (optional)
doublerelativeUnstableThresholdPositive (optional)
doublebztparams
StringalwaysUseVirtualenv (optional)
booleanbztVersion (optional)
StringgeneratePerformanceTrend (optional)
booleanprintDebugOutput (optional)
booleanuseBztExitCode (optional)
booleanuseSystemSitePackages (optional)
booleanworkingDirectory (optional)
Stringworkspace (optional)
String$class: 'PhabricatorNotifier'commentOnSuccess
booleanuberallsEnabled
booleancoverageCheck
booleancoverageThreshold
doubleminCoverageThreshold
doublecoverageReportPattern
StringpreserveFormatting
booleancommentFile
StringcommentSize
StringcommentWithConsoleLinkOnFailure
booleancustomComment
booleanprocessLint
booleanlintFile
StringlintFileSize
String$class: 'PitPublisher'mutationStatsFile
StringminimumKillRatio
floatkillRatioMustImprove
boolean$class: 'PlayBuilder'playToolHome
StringprojectPath
StringplayVersion
$class: 'Play1x'commands
$class: 'PlayAutoTest'$class: 'PlayBuild'$class: 'PlayClean'$class: 'PlayCompile'$class: 'PlayCustom'parameter
String$class: 'PlayDist'$class: 'PlayInstall'$class: 'PlayJavadoc'$class: 'PlayPackage'$class: 'PlayPrecompile'$class: 'PlayPublish'$class: 'PlayTest'$class: 'PlayTestOnly'parameter
String$class: 'PlayWar'parameter
String$class: 'Play2x'commands
$class: 'PlayAutoTest'$class: 'PlayBuild'$class: 'PlayClean'$class: 'PlayCompile'$class: 'PlayCustom'parameter
String$class: 'PlayDist'$class: 'PlayInstall'$class: 'PlayJavadoc'$class: 'PlayPackage'$class: 'PlayPrecompile'$class: 'PlayPublish'$class: 'PlayTest'$class: 'PlayTestOnly'parameter
String$class: 'PlayWar'parameter
Stringplotgroup
Stringstyle
StringcsvFileName
StringcsvSeries (optional)
file
Stringurl
StringinclusionFlag
StringexclusionValues
StringdisplayTableFlag
booleanexclZero (optional)
booleankeepRecords (optional)
booleanlogarithmic (optional)
booleannumBuilds (optional)
StringpropertiesSeries (optional)
file
Stringlabel
Stringtitle (optional)
StringuseDescr (optional)
booleanxmlSeries (optional)
file
Stringxpath
StringnodeType
Stringurl
Stringyaxis (optional)
StringyaxisMaximum (optional)
StringyaxisMinimum (optional)
StringpmdcanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
Stringpattern (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'PollingBuildStep'bsiToken
StringoverrideGlobalConfig
booleanpollingInterval
intpolicyFailureBuildResultPreference
intclientId
StringclientSecret
Stringusername
StringpersonalAccessToken
StringtenantId
String$class: 'PolyspacePostBuildActions'fileToAttach (optional)
StringmailBody (optional)
StringmailBodyBaseName (optional)
StringmailSubject (optional)
StringmailSubjectBaseName (optional)
StringqueryBaseName (optional)
Stringrecipients (optional)
StringsendToOwners (optional)
Send a different e-mail notification to each recipient with filtered results in attachment. For instance, if you use $ps_helper -report-filter in the Build section of this project to filter results for a file owner, you can send the filtered report to that file owner. Each time you use $ps_helper -report-filter with an owner name, the name is appended to a list of owners. You can send an individual e-mail to all owners in this list.
Specify a base name for file attachments and files containing mail subject and mail body. The recipient name (or owner name) is appended to this base name to create a personalized e-mail for each recipient. The recipient name also determines the e-mail address where this personalized e-mail is sent.
For instance, suppose you specify the following:
If the list of recipients contains the names userA and userB:
userA@emailExtension.com. The email contains the file report_userA.tsv in attachment. The mail subject comes from subject_userA.txt and the mail body comes from body_userA.txt.userB@emailExtension.com. The email contains the file report_userB.tsv in attachment. The mail subject comes from subject_userB.txt and the mail body comes from body_userB.txt.The full e-mail address is determined from the server specified in the E-mail Notification section on the Configure System page. You can create files for attachments and e-mail content through scripts in the Build section of this project. For instance, you can calculate the number of new findings for each owner and use the number in the mail subject for the owner.
To test this personalized e-mail notification, enter an e-mail username (or e-mail address) in the field Unique recipients - Debug only. Instead of separate e-mail notifications to individual recipients, all e-mails are sent to this address. After checking the e-mail content in the notifications, clear this field for later builds.
booleansendToRecipients (optional)
Send a common e-mail notification to multiple users. Specify a comma-separated list of e-mail usernames (or full e-mail addresses). If e-mail usernames are provided, the full e-mail address is determined from the server specified in the E-mail Notification section on the Configure System page.
By default, the e-mail contains the status of the Jenkins build and has no attachment. You can customize the mail subject and body and send a Polyspace report (.tsv file) or another file in attachment. Specify the custom subject and body in text files. You can create files for attachments and e-mail content through scripts in the Build section of this project.
For instance, you can enter this specification:
johndoe, janedoeResults_All.tsvmailsubject_common.txtmailbody_common.txtbooleanuniqueRecipients (optional)
String$class: 'PowerOff'vm
StringevenIfSuspended
booleanshutdownGracefully
booleanignoreIfNotExists
booleangracefulShutdownTimeout (optional)
int$class: 'PragprogBuildStep'displayLanguageCode
StringindicateBuildResult
booleanpretestedIntegrationPublisherprobelyScantargetId
StringcredentialsId
StringprotecodesccredentialsId (optional)
StringprotecodeScGroup (optional)
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/ or with Groups API https://protecode-sc.mydomain.com/api/groups/.
StringconvertToSummary (optional)
protecodesc.xml.
booleancustomHeader (optional)
StringdirectoryToScan (optional)
StringdontZipFiles (optional)
booleanendAfterSendingFiles (optional)
booleanfailIfVulns (optional)
booleanincludeSubdirectories (optional)
booleanpattern (optional)
StringprotecodeScanName (optional)
StringscanOnlyArtifacts (optional)
booleanscanTimeout (optional)
int$class: 'PublishBuild'additionalBuildInfo
buildNumber
StringbuildUrl
StringapplicationName (optional)
StringcredentialsId (optional)
StringtoolchainName (optional)
StringorgName (optional)
String$class: 'PublishDeploy'toolchainName
StringbuildJobName
StringenvironmentName
StringcredentialsId
StringapplicationUrl
StringadditionalBuildInfo
buildNumber
StringapplicationName (optional)
String$class: 'PublishSQ'credentialsId
StringtoolchainName
StringbuildJobName
StringSQHostName
StringSQAuthToken
StringSQProjectKey
StringadditionalBuildInfo
buildNumber
StringapplicationName (optional)
String$class: 'PublishTest'lifecycleStage
Stringcontents
StringtoolchainName
StringbuildJobName
StringcredentialsId
StringadditionalUpload
additionalLifecycleStage
StringadditionalContents
StringadditionalBuildInfo
buildNumber
StringadditionalGate
policyName
StringwillDisrupt (optional)
booleantestEnv
value
StringbranchName
StringenvName
StringapplicationName (optional)
String$class: 'Publisher'escapeExceptionMsg (optional)
If checked, the plug-in escapes the test method's exception messages. Unchecking this allows you to use HTML tags to format the exception message e.g. embed links in the text. (Enabled by default)
booleanescapeTestDescp (optional)
If checked, the plug-in escapes the description string associated with the test method while displaying test method details. Unchecking this allows you to use HTML tags to format the description. (Enabled by default)
booleanfailedFails (optional)
A build is marked FAILURE if the number/percentage of failed tests exceeds the specified threshold.
intfailedSkips (optional)
A build is marked FAILURE if the number/percentage of skipped tests exceeds the specified threshold.
intfailureOnFailedTestConfig (optional)
Allows for a distinction between failing tests and failing configuration methods. Failing tests can be seen as an unstable build whereas failing configuration methods are a failed build. This will trump any settings in Thresholds section.
booleanreportFilenamePattern (optional)
This is a file name pattern that can be used to locate the TestNG XML report files (for example **/target/testng-results.xml).
The path is an Ant-style pattern (e.g. fileset) or a list of files and folders separated by the characters ;:,
TestNG must be configured to generate XML reports using org.testng.reporters.XMLReporter for this plug-in to function.
StringshowFailedBuilds (optional)
If checked, the plug-in includes results from failed builds in the trend graph. (Disabled by default)
Note:
-Dmaven.test.failure.ignore=true option. This results in build with test failures being marked as Unstable, thus distinguishing it from build that failed because of non test related issuesbooleanthresholdMode (optional)
intunstableFails (optional)
A build is marked UNSTABLE if the number/percentage of failed tests exceeds the specified threshold.
intunstableSkips (optional)
A build is marked UNSTABLE if the number/percentage of skipped tests exceeds the specified threshold.
intpublishPureLoadThe plug-in does not execute PureLoad; it only parse JUnit report XML file generated by PureLoad to define if test is success or failure, and to shows a summary page.
To use this plugin you must first execute PureLoad, typically using the PureLoad Runner and save all results as artifacts.
qualityCloudsScancredentialsId
StringinstanceUrl
StringissuesCountThreshold
inttechDebtThreshold
intqcThreshold
inthighSeverityThreshold
intqrebelappName
StringtargetBuild
StringtargetVersion
StringbaselineBuild
StringbaselineVersion
StringapiToken
StringapiUrl
StringcomparisonStrategy
StringslowRequestsAllowed
longexcessiveIoAllowed
longexceptionsAllowed
longslaGlobalLimit
0 means no limit
longDURATION
booleanIO
booleanEXCEPTIONS
boolean$class: 'QTM4JResultPublisher'name
Stringapikey
Stringfile
StringattachFile
booleantestrunname
Stringlabels
Stringsprint
Stringversion
Stringcomponent
Stringformat
Stringplatform
Stringcomment
Stringapikeyserver
Stringjiraurlserver
StringproxyUrl
Stringpassword
Stringtestrunnameserver
Stringlabelsserver
Stringsprintserver
Stringversionserver
Stringcomponentserver
Stringusername
Stringfileserver
StringattachFileServer
booleanformatserver
Stringplatformserver
Stringcommentserver
StringtestToRun
Stringtestrunkey
Stringtestassethierarchy
StringtestCaseUpdateLevel
Stringjirafields
Stringtestrunkeyserver
Stringtestassethierarchyserver
StringtestCaseUpdateLevelServer
Stringjirafieldsserver
Stringdisableaction
boolean$class: 'QTMReportPublisher'qtmUrl
StringqtmAutomationApiKey
StringproxyUrl
StringautomationFramework
StringautomationHierarchy
StringtestResultFilePath
StringbuildName
StringtestSuiteName
StringtestSName
StringplatformName
Stringproject
Stringrelease
Stringcycle
Stringdisableaction
booleanqcdomain
Stringproject
StringplanFolder
StringlabFolder
StringfailOnNoTestResults (optional)
booleanuserDefinedFields (optional)
StringOverOpsQueryactiveTimespan (optional)
StringapplicationName (optional)
- If populated, the plugin will filter the data for the specific application in OverOps.
- If blank, no application filter will be applied in query.
StringapplySeasonality (optional)
booleanbaselineTimespan (optional)
StringcheckCriticalErrors (optional)
net.sf.json.JSONObject
checkNewErrors (optional)
net.sf.json.JSONObject
checkRegressionErrors (optional)
net.sf.json.JSONObject
checkResurfacedErrors (optional)
net.sf.json.JSONObject
checkUniqueErrors (optional)
net.sf.json.JSONObject
checkVolumeErrors (optional)
net.sf.json.JSONObject
criticalExceptionTypes (optional)
A comma delimited list of exception types that are deemed as severe regardless of their volume. If events of any exceptions listed have a count greater than zero, the build will be marked as unstable. Example: NullPointerException,IndexOutOfBoundsException
StringcriticalRegressionDelta (optional)
- If an Existing event has an error rate delta (active window compared to baseline) greater than the set value, it will be marked as a severe regression and will break the build.
doubledebug (optional)
booleandeploymentName (optional)
(Optional) Deployment Name as specified in OverOps or use Jenkins environment variables.
Example: ${BUILD_NUMBER} or ${JOB_NAME}-${BUILD_NUMBER}
- If populated, the plugin will filter the data for the specific deployment name in OverOps
Note: If using Jenkins environment variables, they must be added to the build’s manifest file for OverOps to use. See this
link for details.
- If blank, no deployment filter will be applied in the query.
StringmarkUnstable (optional)
booleanmaxErrorVolume (optional)
intmaxUniqueErrors (optional)
intminErrorRateThreshold (optional)
- If a New event has a rate greater than the set value, it will be evaluated as severe and could break the build if its event volume is above the Event Volume Threshold.
- If an Existing event has a rate greater than the set value, it will be evaluated as severe and could break the build if its event volume is above the Event Volume Threshold and the Critical Regression Threshold.
- If an event has a rate less than the set value, it will not be evaluated as severe and will not break the build.
doubleminVolumeThreshold (optional)
The minimal number of times an event of a non-critical type (e.g. uncaught) must take place to be considered severe.- If a New event has a count greater than the set value, it will be evaluated as severe and could break the build if its event rate is above the Event Rate Threshold.- If an Existing event has a count greater than the set value, it will be evaluated as severe and could break the build if its event rate is above the Event Rate Threshold and the Critical Regression Threshold.- If any event has a count less than the set value, it will not be evaluated as severe and will not break the build.
intnewEvents (optional)
booleanprintTopIssues (optional)
intregexFilter (optional)
Example filter expression with pipe separated list - "type":\"s*(Logged Error|Logged Warning|Timer)
StringregressionDelta (optional)
- If an Existing event has an error rate delta (active window compared to baseline) greater than the set value, it will be marked as a regression, but will not break the build.
doubleresurfacedErrors (optional)
booleanserviceId (optional)
Stringquestavrmvrmdata
Specify the location of where the regression results will be stored. By default, VRM creates a directory called VRMDATA which will be located in the CWD where the regression is invoked. Alternatively this can be overridden by specifying a directory upon invocation as follows:
vrun -vrmdata <my_directory> ...
StringcollectCoverage (optional)
booleanenableVcoverExec (optional)
vcoverExec
StringextraArgs (optional)
Extra options to be passed to vrun -status.
StringhealthScaleFactor (optional)
doublehtmlReport (optional)
booleantestDataPublishers (optional)
hudson.tasks.junit.TestDataPublisher
vrmhtmldir (optional)
Specify the directory where the html report will be stored.
StringvrunExec (optional)
Set path to Questa VRM executable. This can be just "vrun" or a complete path.
StringacrQuickTaskazureCredentialsId
StringresourceGroupName
StringregistryName
Stringarchitecture (optional)
StringbuildArgs (optional)
docker build --build-arg.
key
Stringvalue
Stringsecrecy
booleandockerfile (optional)
StringgitPath (optional)
StringgitRefspec (optional)
StringgitRepo (optional)
https://PAT@github.com/user/repo.git for private repo.
StringimageNames (optional)
image
Stringlocal (optional)
StringnoCache (optional)
no-cache flag when build as
docker build --no-cache
booleanos (optional)
StringsourceType (optional)
Stringtarball (optional)
http://remoteserver/myapp.tar.gz
Stringtimeout (optional)
intvariant (optional)
String$class: 'RSpecTestReportPublisher'reportsDirectory
StringfileIncludePattern
StringfileExcludePattern
StringmarkAsUnstable
booleancopyHTMLInWorkspace
boolean$class: 'RTCGitBuilder'serverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringannotateChangeLog
Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
booleanbuildDefinition (optional)
The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
StringjenkinsRootURI (optional)
StringjenkinsRootURIOverride (optional)
Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
booleantimeout (optional)
The timeout period in seconds for Jazz repository requests made during the build.
inttrackBuildWorkItem (optional)
Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
StringuseBuildDefinition (optional)
booleanuseTrackBuildWorkItem (optional)
booleanuseWorkItems (optional)
booleanworkItemUpdateType (optional)
String$class: 'RTCPostBuildDeliverPublisher'Perform post build deliver for Rational Team Concert(RTC) SCM configuration in the Jenkins build.
In a Pipeline job where RTC SCM can be called multiple times, post build deliver will be attempted for each invocation of RTC SCM.
Currently, post build deliver is performed only if a build definition is used as the build configuration. The step uses the post build deliver configuration information from the build definition.
failOnError
If post build deliver operation fails, set the build's status to FAILURE.
booleanrabbitMQPublisherrabbitName
Stringexchange
Stringdata
Stringconversion (optional)
booleanroutingKey (optional)
StringtoJson (optional)
boolean$class: 'RadarGunPublisher'rancherenvironmentId
Stringendpoint
StringcredentialId
Stringservice
Stringimage
Stringconfirm
booleanstartFirst
booleanports
Stringenvironments
Stringtimeout
int$class: 'RcovPublisher'reportDir
Stringtargets (optional)
metric
TOTAL_COVERAGE, CODE_COVERAGEhealthy
intunhealthy
intunstable
int$class: 'Reconfigure'vm
StringreconfigureSteps
$class: 'ReconfigureAnnotation'annotation (optional)
Stringappend (optional)
boolean$class: 'ReconfigureCpu'cpuCores
StringcoresPerSocket
String$class: 'ReconfigureDisk'diskSize
Stringdatastore
String$class: 'ReconfigureMemory'memorySize
String$class: 'ReconfigureNetworkAdapters'deviceAction
ADD, EDIT, REMOVEdeviceLabel
StringmacAddress
StringstandardSwitch
booleanportGroup
StringdistributedSwitch
booleandistributedPortGroup
StringdistributedPortId
StringandroidApkMoveapkFilesPattern (optional)
StringapplicationId (optional)
StringfromVersionCode (optional)
booleangoogleCredentialsId (optional)
StringrolloutPercentage (optional)
StringtrackName (optional)
StringversionCodes (optional)
String$class: 'RemoteBuildConfiguration'abortTriggeredJob (optional)
booleanauth2 (optional)
CredentialsAuthcredentials (optional)
StringNoneAuthNullAuthTokenAuthapiToken (optional)
StringuserName (optional)
StringblockBuildUntilComplete (optional)
booleandisabled (optional)
booleanenhancedLogging (optional)
booleanjob (optional)
StringloadParamsFromFile (optional)
booleanmaxConn (optional)
intparameterFile (optional)
Stringparameters (optional)
StringpollInterval (optional)
intpreventRemoteBuildQueue (optional)
booleanremoteJenkinsName (optional)
StringremoteJenkinsUrl (optional)
StringshouldNotFailBuild (optional)
booleantoken (optional)
StringuseCrumbCache (optional)
booleanuseJobInfoCache (optional)
boolean$class: 'Rename'oldName
StringnewName
String$class: 'RenameSnapshot'vm
StringoldName
StringnewName
StringnewDescription
StringcrxReplicatepackageIds (optional)
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longpublishGeneratorsPublishes and generates reports by configuration of predefined and/or custom report generators.
These reports will be generated for all configured ECU-TEST packages or projects in this job.
publishGenerators(String toolName, List<ReportGeneratorConfig> generators, List<ReportGeneratorConfig> customGenerators) : void
publishGenerators(ETInstallation installation, List<ReportGeneratorConfig> generators, List<ReportGeneratorConfig> customGenerators,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ETInstance.publishGenerators(List<ReportGeneratorConfig> generators, List<ReportGeneratorConfig> customGenerators,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
publishGenerators toolName: 'ECU-TEST', generators: [[name: 'JSON']]
def instance = ET.installation('ECU-TEST')
publishGenerators installation: instance.installation, generators: [[name: 'JSON']]
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishGenerators([[name: 'JSON']], [name: 'Custom-JSON')])
toolName
StringallowMissing (optional)
booleanarchiving (optional)
booleancustomGenerators (optional)
name
Stringsettings
name
Stringvalue
StringusePersistedSettings
booleangenerators (optional)
name
Stringsettings
name
Stringvalue
StringusePersistedSettings
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanrunOnFailed (optional)
boolean$class: 'RevertToSnapshot'vm
StringsnapshotName
StringpublishReview$class: 'RichTextPublisher'stableText
Specify rich text to be published on build and job summary pages for stable and (if corresponding checkboxes are selected) for unstable and failed builds. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.
Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).
StringunstableText
Specify rich text to be published on build anyd job summary pages for unstable builds. This text will be used only if "The same text for unstable builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.
Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).
StringfailedText
Specify rich text to be published on build and job summary pages for failed builds. This text will be used only if "The same text for failed builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.
Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).
StringabortedText
Specify rich text to be published on build and job summary pages for aborted builds. This text will be used only if "The same text for aborted builds as for stable" checkbox is not selected. Build parameters may be put in ${PARAM_NAME} format. Global environment variable values may be put in ${ENV:VAR_NAME} format.
Content of specified files may be also added to summary page. Use ${FILE:path/to/file.txt} to put entire file contents. Use ${FILE_SL:path/to/file.txt} to put file contents as single line (all CR and LF symbols are skipped).
StringunstableAsStable
booleanfailedAsStable
booleanabortedAsStable
booleanparserName
StringnullAction
Select what happens in the case that the buildstate is null or unknown
String$class: 'RobotPublisher'Publishes Robot Framework test reports into Hudson user interface.
Note that you must configure your build to produce these reports before you can publish them with this plugin.
All text fields support the use of environment variables available during build (e.g. ${BUILD_NUMBER}).
outputPath
StringoutputFileName
File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/output*.xml).
Splitted files will be copied automatically. If file name is specified output.xml then all output-xxx.xml will be saved.
StringdisableArchiveOutput
output xml files are not needed by Jenkins once the publishing step of the build is finished.
They are archived for traceability or reuse in some other context.
You might want to disable archiving of those output xml files to save disk space on the Jenkins server.
booleanreportFileName
File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/report*.html).
Splitted files will be copied automatically. If file name is specified report.html then all report-xxx.html will be saved.
StringlogFileName
File name relative to output path. Supports Ant GLOB style wildcards (e.g. **/log*.html).
Splitted files will be copied automatically. If file name is specified log.html then all log-xxx.html will be saved.
StringpassThreshold
doubleunstableThreshold
doubleonlyCritical
booleanotherFiles
Comma separated list of file names relative to output path. Supports Ant GLOB style wildcards (e.g. **/screenshot*.jpg).
You can save any artifacts related to tests (e.g. Selenium screenshots) in the robot directory by configuring the filenames here. Items that are linked to the robot log files - like screenshots - have to be explicitly saved here in order to view them in the stored logs.
StringenableCache
Enable cache for test results (produces memory pressure)
boolean$class: 'RollbackBuilder'basePath (optional)
StringchangeLogFile (optional)
StringchangeLogParameters (optional)
Stringclasspath (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringdatabaseEngine (optional)
StringdefaultSchemaName (optional)
StringdriverClassname (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
StringnumberOfChangesetsToRollback (optional)
Stringpassword (optional)
StringrollbackLastHours (optional)
StringrollbackToDate (optional)
StringrollbackToTag (optional)
StringrollbackType (optional)
Stringurl (optional)
StringuseIncludedDriver (optional)
booleanusername (optional)
String$class: 'RunApplicationAction'applicationName
Application selection is mandatory
Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
StringactionName
Application Action selection is mandatory
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringrunFromAlmBuilderalmServerName
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringalmTestSets
StringalmRunResultsMode
StringalmTimeout
StringalmRunMode
StringalmRunHost
StringisFilterTestsEnabled (optional)
booleanfilterTestsModel (optional)
blockedCheckbox
booleanfailedCheckbox
booleannotCompletedCheckbox
booleannoRunCheckbox
booleanpassedCheckbox
booleantestName (optional)
String$class: 'RunFromFileBuilder'fsTests
StringfileSystemTestSetModel
fileSystemTestSet
tests
StringparallelRunnerEnvironments
environment
StringenvironmentType
StringsummaryDataLogModel
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringscriptRTSSetModel
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringisParallelRunnerEnabled (optional)
booleanuftSettingsModel (optional)
selectedNode (optional)
StringnumberOfReruns (optional)
StringcleanupTest (optional)
StringonCheckFailedTest (optional)
StringfsTestType (optional)
StringrerunSettingsModels (optional)
test (optional)
Stringchecked (optional)
booleannumberOfReruns (optional)
intcleanupTest (optional)
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsAutActions (optional)
StringfsDeviceId (optional)
StringfsDevicesMetrics (optional)
StringfsExtraApps (optional)
StringfsInstrumented (optional)
StringfsJobId (optional)
StringfsLaunchAppName (optional)
StringfsManufacturerAndModel (optional)
StringfsOs (optional)
StringfsPassword (optional)
StringfsReportPath (optional)
StringfsTargetLab (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringfsUserName (optional)
StringignoreErrorStrings (optional)
StringmcServerName (optional)
StringmcTenantId (optional)
StringperScenarioTimeOut (optional)
StringproxySettings (optional)
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
hudson.util.Secret
useSSL (optional)
booleanruntpjobprojectId (optional)
StringjobId (optional)
StringwaitJobFinishSeconds (optional)
int$class: 'RunLoadRunnerScript'scriptsPath
String$class: 'RunPcTestBuildStep'almPassword (optional)
StringalmUser (optional)
Stringdomain (optional)
StringfailIfTaskFails (optional)
booleanoutputDir (optional)
StringpollingInterval (optional)
intpostRunActionString (optional)
Stringproject (optional)
StringretryCollateAndAnalysisAttempts (optional)
intretryCollateAndAnalysisFlag (optional)
booleanretryCollateAndAnalysisInterval (optional)
intretryCount (optional)
intretryInterval (optional)
intretryIntervalMultiplier (optional)
doubletestLabPath (optional)
StringtestPlanPath (optional)
Stringtimeout (optional)
inttimeslotDuration (optional)
intvudsMode (optional)
booleanjmhReportresultPath
String$class: 'RunResultRecorder'archiveTestResultsMode
String$class: 'RunTestSetBuildStep'domain
Stringproject
StringrunMode
Stringhost
StringtestSets
StringoutputDirPath
StringtimeOut
int$class: 'RunUftTestBuildStep'testPath
StringoutputDirPath
String$class: 'RundeckNotifier'rundeckInstance
StringjobId
Stringoptions
This is the list of options for the Rundeck job you want to execute. It should be in the Java-Properties format, 1 option per line : key=value.
You can use Jenkins environment variables ($BUILD_NUMBER, $BUILD_ID, $JOB_NAME, $WORKSPACE, etc) or System environment variables ($HOME, $PATH, etc) in your options, and we will expand them when notifying Rundeck.
We will also expand the special token "$ARTIFACT_NAME{regex}" (where "regex" is a java-regex) to the name of the first matching artifact found.
For example, $ARTIFACT_NAME{.*\.war} will matches your WAR artifact, while $ARTIFACT_NAME{.*-sources\.jar} will matches your sources artifact.
StringnodeFilters
This is a list of filters to optionally filter the nodes on which your Rundeck will run.
You can specify which node to include and/or to exclude using a single value, a list of values, or a regular expression (for example the .* pattern will match any text) as the argument to the following options.
Inclusion filters
Exclusion filters
Predecence is the issue of whether a node should be included in the result set when it matches both an exclusion filter and an inclusion filter.
This field should be written in the Java-Properties format, 1 option per line : key=value.
You can use Jenkins environment variables ($JOB_NAME, $WORKSPACE, etc) or System environment variables ($OSTYPE, $USER, etc) in your values, and we will expand them when notifying Rundeck.
Example :
tags = web+prod
exclude-os-family = windows
Stringtags
StringshouldWaitForRundeckJob
booleanshouldFailTheBuild
booleannotifyOnAllStatus
booleanincludeRundeckLogs
booleantailLog
booleanjobUser
This is an alternative rundeck userid, which should be used instead of the global configured id. 'User password' is mandatory with 'job user', also a token can be used for authentication.
StringjobPassword
StringjobToken
Strings3UploadprofileName
Stringentries
bucket
StringsourceFile
StringexcludedFile
StringstorageClass
StringselectedRegion
StringnoUploadOnFailure
booleanuploadFromSlave
booleanmanagedArtifacts
booleanuseServerSideEncryption
booleanflatten
booleangzipFiles
booleankeepForever
booleanshowDirectlyInBrowser
booleanuserMetadata
key
Stringvalue
StringuserMetadata
key
Stringvalue
StringdontWaitForConcurrentBuildCompletion
booleanconsoleLogLevel
StringpluginFailureResultConstraint
Strings3CopyArtifactprojectName
StringbuildSelector
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacefilter
StringexcludeFilter
Stringtarget
Stringflatten
booleanoptional
booleanscmSkipdeleteBuild (optional)
booleanskipPattern (optional)
StringsilkcentralprojectId
intexecDefIds
StringbuildNumberUsageOption (optional)
intcollectResults (optional)
booleancontOnErr (optional)
booleandelay (optional)
intignoreSetupCleanup (optional)
booleanjobName (optional)
StringspecificPassword (optional)
StringspecificServiceURL (optional)
StringspecificUser (optional)
StringuseSpecificInstance (optional)
booleansilkcentralCollectResultssdelementsprojectId
intconnectionName
StringmarkUnstable (optional)
boolean$class: 'SQLPlusRunnerBuilder'credentialsId
Stringinstance
StringscriptType
Stringscript
StringscriptContent
| SELECT sysdate from dual; show user; |
StringcustomOracleHome (optional)
StringcustomSQLPlusHome (optional)
StringcustomTNSAdmin (optional)
String$class: 'SaltAPIBuilder'authtype
StringclientInterface
hookpost
Stringtag
Stringbatchfunction
Stringarguments
StringbatchSize
StringbatchWait
Stringtarget
Stringtargettype
Stringlocalfunction
Stringarguments
Stringtarget
Stringtargettype
Stringblockbuild (optional)
booleanjobPollTime (optional)
intminionTimeout (optional)
intsubsetfunction
Stringarguments
Stringsubset
Stringtarget
Stringtargettype
Stringrunnerfunction
Stringarguments
Stringmods
Stringpillarvalue
StringcredentialsId
Stringservername (optional)
StringsaveEnvVar (optional)
booleansaveFile (optional)
booleanskipValidation (optional)
booleansaucePublisherSauceOnDemandSessionID lines and will attempt to update the job on sauce labs with the proper status. See
the Sauce Labs wiki for more information
testDataPublishers (optional)
$class: 'AttachmentPublisher'$class: 'AutomateTestDataPublisher'$class: 'ClaimTestDataPublisher'$class: 'JUnitFlakyTestDataPublisher'jiraTestResultReporterconfigs
jiraSelectableArrayFieldfieldKey
Stringvalues
value
StringjiraSelectableFieldfieldKey
Stringvalue
StringjiraStringArrayFieldfieldKey
Stringvalues
value
StringjiraStringFieldfieldKey
Stringvalue
Insert a string value.
You can include Jenkins Environment variables (see link), or the following variables defined by this plugin:
Variable usage: ${VAR_NAME}CRFL - new line
DEFAULT_SUMMARY - configured in the global configuration page
DEFAULT_DESCRIPTION - configured in the global configuration page
TEST_RESULT
TEST_NAME
TEST_FULL_NAME
TEST_STACK_TRACE
TEST_ERROR_DETAILS
TEST_DURATION
TEST_PACKAGE_NAME
TEST_STDERR
TEST_STDOUT
TEST_OVERVIEW
TEST_AGE
TEST_PASS_COUNT
TEST_SKIPPED_COUNT
TEST_FAIL_SINCE
TEST_IS_REGRESSION - expands to true/false
BUILD_RESULT
String$class: 'UserFields'fieldKey
Stringvalue
Insert the username.
For example if you have a user with:
Display Name: John Doe, Username: johndoe, Email: johndoe@email.com,
you need to write johndoe in this field. Any other value (like display name, or email) will not work.
StringprojectKey
StringissueType
StringautoRaiseIssue
booleanautoResolveIssue
booleanautoUnlinkIssue
boolean$class: 'JunitResultPublisher'urlOverride
String$class: 'PerfSigTestDataPublisher'dynatraceProfile
String$class: 'SahaginTestDataPublishser'$class: 'SauceOnDemandReportPublisher'jobVisibility (optional)
String$class: 'StabilityTestDataPublisher'$class: 'TestReporter'scmHttpClienturl
StringaddScmPath (optional)
added custom paths to each affected scm path.
e.g., Add scmPath: testOne
assuming you get the current scm affected path list: [["src/main/java/Test.java"],["app/src/main/java/HelloWorld.java"]]
With the handle, the result: you will get a new affected path list: [["testOne","src/main/java/Test.java"],["testOne","src/main/java/HelloWorld.java"]]
if you need to add more, Add scmPath can be use like: testOne,testTwo,testThird
StringcontentType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMcredentialId (optional)
StringhttpMode (optional)
GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCHregexString (optional)
using regular expression to handle each affected scm path.
eg: Regex string: src.*java
assuming you get the current scm affected path list: [["src/main/java/Test.java"],["app/src/main/java/HelloWorld.java"]]
With the handle, the result: you will get a new affected path list: [["src/main/java/Test.java"],["src/main/java/HelloWorld.java"]]
StringrequestBody (optional)
StringsaveAffectedPath (optional)
it will be use like $(AFFECTED_PATH) on request body.
booleansaveJobBuildMessage (optional)
it will be use like $(JOB_BUILD_MESSAGE) on request body.
booleansendHttpRequest (optional)
booleanvalidResponseCodes (optional)
StringvalidResponseContent (optional)
String$class: 'ScoveragePublisher'reportDir
StringreportFile
String$class: 'ScriptBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringscript
Stringfile
The full file path including name and extension of the SQL file to execute. Please note that this is relative to the machine running the job.
StringsourceType
StringoutputName
StringlimitMaxRows
StringmaxRows
The maximum number of returned rows if any rows are to be returned.
int$class: 'SeleniumHtmlReportPublisher'failureIfExceptionOnParsingResultFiles (optional)
booleantestResultsDir (optional)
String$class: 'SelfServiceBookmarkBuilder'delphixEngine
StringdelphixBookmark
StringdelphixOperation
StringdelphixContainer
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SelfServiceContainerBuilder'delphixEngine
StringdelphixEnvironment
StringdelphixOperation
StringdelphixBookmark
StringloadFromProps (optional)
booleansaveToProps (optional)
booleanData TheorembuildToUpload
The build file name that you want to send to Data Theorem. The build has to be generated either in the workspace or in the archive directory
If the name of the target is variable, you can mark the variable part with "*" example: com.*.generatebuild.*.apk
StringdontUpload
Check this option to print the path of the build output without uploading anything
You can use this option to simulate the plugin features without sending anything to Data Theorem
boolean$class: 'SendMessageBuildStep'message
Stringfilepath
Stringrecipients
id
StringicqMessagemessage
Stringfilepath
Stringrecipients
id
Stringsucceeded
booleanunstable
booleanfailed
booleanaborted
boolean$class: 'SendNotification'name (optional)
Stringparams (optional)
java.lang.Object>
spaceName (optional)
StringsensediaApiDeployenviromentName
Stringrevision
StringsensediaApiJsonapiId
StringsensediaApiQArevisionNumber
intdestination
booleanlogInterceptor
booleanresourceOutOfSize
booleanresourceSize
int$class: 'ServiceFabricPublisher'publishStep
applicationName (optional)
StringapplicationType (optional)
StringazureCredentialsId (optional)
StringclientCert (optional)
StringclientKey (optional)
StringconfigureType (optional)
StringmanagementHost (optional)
StringmanifestPath (optional)
StringresourceGroup (optional)
StringserviceFabric (optional)
StringsignAndroidApksandroidHome (optional)
zipalign tool. You can also set the
ANDROID_HOME environment variable in your Jenkins system or node configuration. E.g.,
/usr/local/android-sdk.
StringapksToSign (optional)
myApp/build/outputs/apk/myApp-unsigned.apk or
**/*-unsigned.apk or
app1/**/*-unsigned.apk, app2/**/*-unsigned.apk.
StringarchiveSignedApks (optional)
SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk, where
myApp-unsigned.apk is a directory named for the input unsigned APK.
booleanarchiveUnsignedApks (optional)
booleankeyAlias (optional)
Key Store ID references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
StringkeyStoreId (optional)
StringsignedApkMapping (optional)
unsignedApkNameDirunsignedApkSiblingskipZipalign (optional)
booleanzipalignPath (optional)
zipalign executable this build step should
use to align the target APKs. You can also set the
ANDROID_ZIPALIGN environment variable in your Jenkins system or node configuration. E.g.,
/opt/android-tools/bin/zipalign
String$class: 'SloccountPublisher'pattern
Fileset 'includes' setting that specifies the generated raw SLOCCount or cloc report files, such as '**/sloccount.sc' or '**/cloc.xml'. Basedir of the fileset is the workspace root. If no value is set, then the default '**/sloccount.sc' is used. Be sure not to include any non-report files into this pattern.
The report files must have been generated by sloccount tool using the "--wide --details" options, e.g.
sloccount --duplicates --wide --details SOURCE_DIRECTORY > sloccount.sc
or by cloc tool using the "--by-file --xml" options, e.g.
cloc --by-file --xml --out=cloc.xml SOURCE_DIRECTORY
If you are not sure which type to use, prefer cloc. It is able to detect more programming languages than SLOCCount (Scala, Ant, CSS, ...) and is able to count also lines with comments that often contain Javadoc or Doxygen documentation. Cloc is also better portable, SLOCCount requires cygwin or similar environment under MS Windows.
Never switch between SLOCCount and cloc inside one job. You would end up with messy trend graph because they name programming languages differently. Delete all affected builds and rebuild the job in such case to fix the issue.
Stringencoding
StringcommentIsCode
booleannumBuildsInGraph
intignoreBuildFailure
booleanaddALMOctaneSonarQubeListenerpushCoverage (optional)
booleanpushVulnerabilities (optional)
booleansonarServerUrl (optional)
StringsonarToken (optional)
StringsonarToGerritauthConfig (optional)
password (optional)
Stringusername (optional)
Stringcategory (optional)
StringchangedLinesOnly (optional)
booleanhttpPassword (optional)
StringhttpUsername (optional)
StringinspectionConfig (optional)
autoMatch (optional)
booleanbaseConfig (optional)
autoMatch (optional)
booleanprojectPath (optional)
StringsonarReportPath (optional)
StringserverURL (optional)
StringsubJobConfigs (optional)
autoMatch (optional)
booleanprojectPath (optional)
StringsonarReportPath (optional)
Stringtype (optional)
StringissueComment (optional)
StringissuesNotification (optional)
StringissuesScore (optional)
StringnewIssuesOnly (optional)
booleannoIssuesNotification (optional)
StringnoIssuesScore (optional)
StringnoIssuesToPostText (optional)
StringnotificationConfig (optional)
commentedIssuesNotificationRecipient (optional)
StringnegativeScoreNotificationRecipient (optional)
StringnoIssuesNotificationRecipient (optional)
StringoverrideCredentials (optional)
booleanpath (optional)
StringpostScore (optional)
booleanprojectPath (optional)
StringreviewConfig (optional)
issueCommentTemplate (optional)
StringissueFilterConfig (optional)
changedLinesOnly (optional)
booleannewIssuesOnly (optional)
booleanseverity (optional)
StringnoIssuesTitleTemplate (optional)
StringsomeIssuesTitleTemplate (optional)
StringscoreConfig (optional)
category (optional)
StringissueFilterConfig (optional)
changedLinesOnly (optional)
booleannewIssuesOnly (optional)
booleanseverity (optional)
StringissuesScore (optional)
intnoIssuesScore (optional)
intseverity (optional)
StringsomeIssuesToPostText (optional)
StringsonarURL (optional)
StringsubJobConfigs (optional)
autoMatch (optional)
booleanprojectPath (optional)
StringsonarReportPath (optional)
String$class: 'SparkNotifier'disable
booleannotnotifyifsuccess
booleansparkRoomName
StringpublishContentPrefix
StringpublishContent
Stringinvitetoroom
booleanattachtestresult
[test results]
total:5, failed:0, skiped:0
booleanattachcodechange
[changes]
fujian1115:[job_config.jpg]
fujian1115:[sample.jpg]
boolean$class: 'SplunkArtifactNotifier'includeFiles
StringexcludeFiles
StringpublishFromSlave
booleanskipGlobalSplunkArchive
archive("**/*.log") when the DSL does not fit for specific set of job.
booleansizeLimit
StringspringBootselectedIDs (optional)
StringartifactId (optional)
Stringautocomplete (optional)
StringbootVersion (optional)
Stringdescription (optional)
StringgroupId (optional)
StringjavaVersion (optional)
Stringlanguage (optional)
Stringpackaging (optional)
StringprojectName (optional)
Stringtype (optional)
String$class: 'SquashTMPublisher'selectedServers
identifier
Stringselected
booleansseBuildalmServerName
StringalmProject
StringcredentialsId
StringclientType
StringalmDomain
StringrunType
StringalmEntityId
StringtimeslotDuration
StringcdaDetails (optional)
deploymentAction
StringdeployedEnvironmentName
StringdeprovisioningAction
Stringdescription (optional)
StringenvironmentConfigurationId (optional)
StringpostRunAction (optional)
StringosfBuilderSuiteStandaloneSonarLintersourcePatterns (optional)
sourcePattern
StringexcludePatterns
excludePattern
StringreportPath (optional)
StringstartETConfigure and start a preconfigured ECU-TEST installation.
Pipeline usage
startET(String toolName) : void
startET(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debug, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start(String toolName) : void
ETInstance.start(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debug, boolean keepInstance, boolean updateUserLibs) : void
startET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startET installation: instance.installation, workspaceDir: 'C:\\Data'
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.start()
toolName
StringdebugMode (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepInstance (optional)
booleansettingsDir (optional)
Stringtimeout (optional)
StringupdateUserLibs (optional)
booleanworkspaceDir (optional)
StringstartTSConfigure and start Tool-Server.
Pipeline usage
startTS(String toolName) : void
startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS(String toolName) : void
ETInstance.startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
startTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.startTS()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepInstance (optional)
booleantcpPort (optional)
Stringtimeout (optional)
StringtoolLibsIni (optional)
StringnotifyBitbucketstashServerBaseUrl
StringcredentialsId
StringignoreUnverifiedSSLPeer
booleancommitSha1
StringincludeBuildNumberInKey
Check this if you want results of repeated builds of the same commit to show up in Bitbucket as a list of builds. If unchecked, Bitbucket will only display the latest build result.
booleanprojectKey
StringprependParentProjectKey
booleandisableInprogressNotification
booleanconsiderUnstableAsSuccess
boolean$class: 'StaticAssessmentBuildStep'bsiToken
StringoverrideGlobalConfig
booleanusername
StringpersonalAccessToken
StringtenantId
StringincludeAllFiles
booleanisBundledAssessment
booleanpurchaseEntitlements
booleanentitlementPreference
intisRemediationPreferred
booleanrunOpenSourceAnalysisOverride
booleanisExpressScanOverride
booleanisExpressAuditOverride
booleanincludeThirdPartyOverride
booleangoogleStorageBuildLogUploadcredentialsId
Stringbucket
StringlogName
StringpathPrefix (optional)
StringsharedPublicly (optional)
booleanshowInline (optional)
booleanstopETShutdown ECU-TEST.
Pipelines usage:
stopET(String toolName) : void
stopET(String toolName, int timeout) : void
ETInstance.stop(String toolName) : void
ETInstance.stop(String toolName, int timeout) : void
stopET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopET installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stop()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
timeout (optional)
StringstopTSShutdown Tool-Server.
Pipelines usage:
stopTS(String toolName) : void
stopTS(String toolName, int timeout) : void
ETInstance.stopTS(String toolName) : void
ETInstance.stopTS(String toolName, int timeout) : void
stopTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stopTS()
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
timeout (optional)
String$class: 'StoplightReportPublisher'consoleOrFile
StringresultFile
StringtopazSubmitFreeFormJclconnectionId
StringcredentialsId
StringmaxConditionCode
Stringjcl
StringtopazSubmitJclMembersconnectionId
StringcredentialsId
StringmaxConditionCode
StringjclMember
String$class: 'SumoBuildNotifier'$class: 'SuspendVm'vm
String$class: 'SvChangeModeBuilder'serverName
Stringforce
booleanmode
OFFLINE, SIMULATING, STAND_BY, LEARNINGdataModel
selectionType
BY_NAME, NONE, DEFAULTdataModel
StringperformanceModel
selectionType
BY_NAME, NONE, OFFLINE, DEFAULTperformanceModel
StringserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SvDeployBuilder'serverName
Stringforce
booleanservice
StringprojectPath
StringprojectPassword
StringfirstAgentFallback
boolean$class: 'SvExportBuilder'serverName
Stringforce
booleantargetDirectory
StringcleanTargetDirectory
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringswitchToStandByFirst
booleanarchive
boolean$class: 'SvUndeployBuilder'serverName
StringcontinueIfNotDeployed
booleanforce
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SwampPostBuild'projectUUID
StringassessmentInfo
toolUUID
StringplatformUUID
StringpackageName
StringpackageVersion
StringpackageDir
StringpackageLanguage
StringpackageLanguageVersion
StringbuildSystem
StringbuildDirectory
StringbuildFile
StringbuildTarget
StringbuildCommand
StringbuildOptions
StringconfigCommand
StringconfigOptions
StringconfigDirectory
StringoutputDir
StringcleanCommand
StringcanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'TAReportingRecorder'modifyStatusIfDegraded
booleanmodifyStatusIfVolatile
booleanstatusNameIfDegraded
StringstatusNameIfVolatile
StringprintXmlReportForDebug
boolean$class: 'TATestRunRegistrationBuildStep'This step registers new test run with given category and sets the 'dtTestrunID' build variable.
category
Stringplatform
StringpublishTMSPublishes the test results of all configured ECU-TEST packages or projects in this job to a preconfigured test management system like RQM or ALM.
Pipeline usage
publishTMS(String toolName, String credentialsId, int timeout) : void
publishTMS(ETInstallation installation, String credentialsId, int timeout,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ETInstance.publishTMS(String credentialsId, int timeout) : void
publishTMS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
publishTMS installation: instance.installation, credentialsId: 'id', timeout: 120
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishTMS('id')
toolName
StringcredentialsId
StringallowMissing (optional)
booleanarchiving (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanrunOnFailed (optional)
booleantimeout (optional)
StringpublishTRFallowMissing (optional)
booleanarchiving (optional)
booleankeepAll (optional)
booleanrunOnFailed (optional)
boolean$class: 'TakeSnapshot'vm
StringsnapshotName
Stringdescription
StringincludeMemory
booleantanaguruname
Stringscenario
StringurlToAudit
StringurlTanaguruWebService
StringperformanceUnstableMark
intperformanceFailedMark
intproxy_uri
Stringproxy_username
Stringproxy_password
String$class: 'TapPublisher'testResults
StringfailIfNoResults
booleanfailedTestsMarkBuildAsFailure
booleanoutputTapToConsole
booleanenableSubtests
booleandiscardOldReports
booleantodoIsFailure
booleanincludeCommentDiagnostics
booleanvalidateNumberOfTests
booleanplanRequired
booleanverbose
booleanshowOnlyFailures
booleanstripSingleParents
booleanflattenTapResult
booleanremoveYamlIfCorrupted
booleanskipIfBuildNotOk
boolean$class: 'TargetPlatformPublisher'artifacts
StringlatestOnly
booleantargetPlatformName
Stringexcludes (optional)
StringallowEmptyArchive (optional)
booleancaseSensitive (optional)
org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
booleandefaultExcludes (optional)
booleanfingerprint (optional)
booleanonlyIfSuccessful (optional)
booleanopenTasksasRegexp (optional)
booleancanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringexcludePattern (optional)
Patterns look very much like the patterns used in DOS and UNIX:
'*' matches zero or more characters, '?' matches one character.
In general, patterns are considered relative paths, relative to the Jenkins workspace. Only files found below that base directory are considered. So while a pattern like ../foo.java is possible, it will not match anything when applied since the base directory's parent is never scanned for files.
Examples:
*.java matches .java , x.java and FooBar.java , but not FooBar.xml (does not end with .java ).
?.java matches x.java , A.java , but not .java or xyz.java (both don't have one character before .java ).
Combinations of * 's and ? 's are allowed.
Matching is done per-directory. This means that first the first directory in the pattern is matched against the first directory in the path to match. Then the second directory is matched, and so on. For example, when we have the pattern /?abc/*/*.java and the path /xabc/foobar/test.java , the first ?abc is matched with xabc , then * is matched with foobar , and finally *.java is matched with test.java . They all match, so the path matches the pattern.
To make things a bit more flexible, we add one extra feature, which makes it possible to match multiple directory levels. This can be used to match a complete directory tree, or a file anywhere in the directory tree. To do this, ** must be used as the name of a directory. When ** is used as the name of a directory in the pattern, it matches zero or more directories. For example: /test/** matches all files/directories under /test/ , such as /test/x.java , or /test/foo/bar/xyz.html , but not /xyz.xml .
There is one "shorthand": if a pattern ends with / or \ , then ** is appended. For example, mypackage/test/ is interpreted as if it were mypackage/test/** .
Example patterns:
**/CVS/* |
Matches all files in CVS directories that can be located anywhere in the directory tree.Matches:
CVS/Repository
org/apache/CVS/Entries
org/apache/jakarta/tools/ant/CVS/Entries
But not:
org/apache/CVS/foo/bar/Entries ( |
org/apache/jakarta/** |
Matches all files in the org/apache/jakarta directory tree.Matches:
org/apache/jakarta/tools/ant/docs/index.html
org/apache/jakarta/test.xml
But not:
org/apache/xyz.java
(jakarta/ part is missing). |
org/apache/**/CVS/* |
Matches all files in CVS directories that are located anywhere in the directory tree under org/apache.Matches:
org/apache/CVS/Entries
org/apache/jakarta/tools/ant/CVS/Entries
But not:
org/apache/CVS/foo/bar/Entries
(foo/bar/ part does not match) |
**/test/** |
Matches all files that have a test element in their path, including test as a filename. |
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
Stringhigh (optional)
StringignoreCase (optional)
booleanlow (optional)
Stringnormal (optional)
Stringpattern (optional)
Patterns look very much like the patterns used in DOS and UNIX:
'*' matches zero or more characters, '?' matches one character.
In general, patterns are considered relative paths, relative to the Jenkins workspace. Only files found below that base directory are considered. So while a pattern like ../foo.java is possible, it will not match anything when applied since the base directory's parent is never scanned for files.
Examples:
*.java matches .java , x.java and FooBar.java , but not FooBar.xml (does not end with .java ).
?.java matches x.java , A.java , but not .java or xyz.java (both don't have one character before .java ).
Combinations of * 's and ? 's are allowed.
Matching is done per-directory. This means that first the first directory in the pattern is matched against the first directory in the path to match. Then the second directory is matched, and so on. For example, when we have the pattern /?abc/*/*.java and the path /xabc/foobar/test.java , the first ?abc is matched with xabc , then * is matched with foobar , and finally *.java is matched with test.java . They all match, so the path matches the pattern.
To make things a bit more flexible, we add one extra feature, which makes it possible to match multiple directory levels. This can be used to match a complete directory tree, or a file anywhere in the directory tree. To do this, ** must be used as the name of a directory. When ** is used as the name of a directory in the pattern, it matches zero or more directories. For example: /test/** matches all files/directories under /test/ , such as /test/x.java , or /test/foo/bar/xyz.html , but not /xyz.xml .
There is one "shorthand": if a pattern ends with / or \ , then ** is appended. For example, mypackage/test/ is interpreted as if it were mypackage/test/** .
Example patterns:
**/CVS/* |
Matches all files in CVS directories that can be located anywhere in the directory tree.Matches:
CVS/Repository
org/apache/CVS/Entries
org/apache/jakarta/tools/ant/CVS/Entries
But not:
org/apache/CVS/foo/bar/Entries ( |
org/apache/jakarta/** |
Matches all files in the org/apache/jakarta directory tree.Matches:
org/apache/jakarta/tools/ant/docs/index.html
org/apache/jakarta/test.xml
But not:
org/apache/xyz.java
(jakarta/ part is missing). |
org/apache/**/CVS/* |
Matches all files in CVS directories that are located anywhere in the directory tree under org/apache.Matches:
org/apache/CVS/Entries
org/apache/jakarta/tools/ant/CVS/Entries
But not:
org/apache/CVS/foo/bar/Entries
(foo/bar/ part does not match) |
**/test/** |
Matches all files that have a test element in their path, including test as a filename. |
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
booleantestcompletetestsuite (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringcommandLineArguments (optional)
StringexecutorType (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleanlaunchConfig (optional)
project (optional)
Stringroutine (optional)
Stringtest (optional)
Stringunit (optional)
Stringvalue (optional)
StringlaunchType (optional)
Stringproject (optional)
StringpublishJUnitReports (optional)
booleanroutine (optional)
StringsessionScreenResolution (optional)
Stringtest (optional)
Stringtimeout (optional)
Stringunit (optional)
StringuseActiveSession (optional)
booleanuseTCService (optional)
booleanuseTimeout (optional)
booleanuserName (optional)
StringuserPassword (optional)
String$class: 'TeamCollectResultsPostBuildAction'requestedResults (optional)
teamResultType
JUNIT, NUNIT, VS_TEST, XUNIT, COBERTURA, JACOCOincludes (optional)
**/target/surefire-reports/TEST-*.xml, **/target/failsafe-reports/TEST-*.xmlreports/jacoco.exec**/TestResults/*.xmlString$class: 'TeamCompletedStatusPostBuildAction'$class: 'TeamPendingStatusBuildStep'$class: 'TeamUpdateWorkItemPostBuildAction'$class: 'TelegramBotBuilder'message
StringtelegramSendmessage
String$class: 'TelegramBotPublisher'message
StringwhenSuccess
booleanwhenUnstable
booleanwhenFailed
booleanwhenAborted
booleantestFoldertestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTIONrecursiveScan (optional)
booleanscanMode (optional)
PACKAGES_ONLY, PROJECTS_ONLY, PACKAGES_AND_PROJECTStestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestNGTestReportPublisher'reportsDirectory
StringfileIncludePattern
StringfileExcludePattern
StringmarkAsUnstable
booleancopyHTMLInWorkspace
booleantestPackagetestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
StringtestProjecttestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTIONtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestReportDeployPublisher'name
Stringapikey
Stringfile
StringattachFile
booleantestrunname
Stringlabels
Stringsprint
Stringversion
Stringcomponent
Stringformat
Stringplatform
Stringcomment
Stringapikeyserver
Stringjiraurlserver
StringproxyUrl
Stringpassword
Stringtestrunnameserver
Stringlabelsserver
Stringsprintserver
Stringversionserver
Stringcomponentserver
Stringusername
Stringfileserver
StringattachFileServer
booleanformatserver
Stringplatformserver
Stringcommentserver
StringtestToRun
Stringtestrunkey
Stringtestassethierarchy
StringtestCaseUpdateLevel
Stringjirafields
Stringtestrunkeyserver
Stringtestassethierarchyserver
StringtestCaseUpdateLevelServer
Stringjirafieldsserver
Stringdisableaction
boolean$class: 'TestReportDeployPublisherCloudV4'testToRun
Stringapikey
Stringfile
StringattachFile
booleanformat
Stringdisableaction
booleantestCycleToReuse
Stringenvironment
Stringbuild
StringtestCycleLabels
StringtestCycleComponents
StringtestCyclePriority
StringtestCycleStatus
StringtestCycleSprintId
StringtestCycleFixVersionId
StringtestCycleSummary
StringtestCaseLabels
StringtestCaseComponents
StringtestCasePriority
StringtestCaseStatus
StringtestCaseSprintId
StringtestCaseFixVersionId
StringpublishTestResultsserverAddress
StringprojectKey
StringfilePath
StringautoCreateTestCases
booleanformat
StringuploadResultToALMalmServerName
StringcredentialsId
StringalmDomain
StringclientType
StringalmProject
StringtestingFramework
StringtestingTool
StringalmTestFolder
StringalmTestSetFolder
StringalmTimeout
StringtestingResultFile
StringjenkinsServerUrl
String$class: 'TestStudioAPITestBuilder'apiRunnerPath (optional)
Stringproject (optional)
Stringtest (optional)
StringstartFrom (optional)
StringstopAfter (optional)
Stringvariable (optional)
StringdontSaveContexts (optional)
booleantestAsUnit (optional)
boolean$class: 'TestStudioTestBuilder'artOfTestRunnerPath
StringtestPath
StringsettingsPath
StringdateFormat
| Letter | Date or Time Component | Presentation | Examples |
|---|---|---|---|
| G | Era designator | Text | AD |
| y | Year | Year | 1996; 96 |
| Y | Week year | Year | 2009; 09 |
| M/L | Month in year | Month | July; Jul; 07 |
| w | Week in year | Number | 27 |
| W | Week in month | Number | 2 |
| D | Day in year | Number | 189 |
| d | Day in month | Number | 10 |
| F | Day of week in month | Number | 2 |
| E | Day in week | Text | Tuesday; Tue |
| u | Day number of week | Number | 1 |
| a | Am/pm marker | Text | PM |
| H | Hour in day (0-23) | Number | 0 |
| k | Hour in day (1-24) | Number | 24 |
| K | Hour in am/pm (0-11) | Number | 0 |
| h | Hour in am/pm (1-12) | Number | 12 |
| m | Minute in hour | Number | 30 |
| s | Second in minute | Number | 55 |
| S | Millisecond | Number | 978 |
| z | Time zone | General time zone | Pacific Standard Time; PST; GMT-08:00 |
| Z | Time zone | RFC 822 time zone | -0800 |
| X | Time zone | ISO 8601 time zone | -08; -0800; -08:00 |
| Input string | Pattern |
|---|---|
| 2001.07.04 AD at 12:08:56 PDT | yyyy.MM.dd G 'at' HH:mm:ss z |
| Wed, Jul 4, '01 | EEE, MMM d, ''yy |
| 12:08 PM | h:mm a |
| 12 o'clock PM, Pacific Daylight Time | hh 'o''clock' a, zzzz |
| 0:08 PM, PDT | K:mm a, z |
| 02001.July.04 AD 12:08 PM | yyyyy.MMMM.dd GGG hh:mm aaa |
| Wed, 4 Jul 2001 12:08:56 -0700 | EEE, d MMM yyyy HH:mm:ss Z |
| 010704120856-0700 | yyMMddHHmmssZ |
| 2001-07-04T12:08:56.235-0700 | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| 2001-07-04T12:08:56.235-07:00 | yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| 2001-W27-3 | YYYY-'W'ww-u |
StringprojectRoot (optional)
StringtestAsUnit (optional)
booleanoutputPath (optional)
StringtestweaverprojectPath
StringexperimentName
StringjUnitReportDirectory
StringhtmlReportDirectory (optional)
StringinstrumentView (optional)
booleannamespacePattern (optional)
StringparameterValues (optional)
StringrunScenarioLimit (optional)
intrunTimeLimit (optional)
longsilverParameters (optional)
String$class: 'TesteinRunBuilder'targetType
StringtargetId
StringdownloadReport
booleandownloadLogs
boolean$class: 'TesteinUploadStepBuilder'enableJs
jsFilePath
StringjsonFilePath
StringenableJar
jarFilePath
Stringoverwrite
boolean$class: 'TestiniumPlugin'projectId (optional)
intplanId (optional)
intabortOnError (optional)
booleanabortOnFailed (optional)
booleanfailOnTimeout (optional)
booleanignoreInactive (optional)
booleantimeoutSeconds (optional)
intconvertTestsToRunframework
Stringformat
Stringdelimiter
StringfindTextregexp
StringalsoCheckConsoleOutput (optional)
booleanfileSet (optional)
logs/**/*/*.txt. See
the @includes of Ant fileset for the exact format. Leave this empty if you do not want to scan any files (usually combined with checked
Also search the console output).
StringnotBuiltIfFound (optional)
booleansucceedIfFound (optional)
booleanunstableIfFound (optional)
booleanthemisRefreshinstanceName
StringprojectKey
StringfailBuild (optional)
booleanonlyOnSuccess (optional)
boolean$class: 'ThreadFixPublisher'appId
StringscanFiles
The application scan artifacts to upload to the ThreadFix server.
path
The path to the scan artifact with the appropriate extension. Jenkins environment variables are acceptable. Examples:
${BUILD_TAG}.fpr (Linux) or %BUILD_TAG%.fpr (Windows)${BUILD_TAG}.scan(Linux) %BUILD_TAG%.scan (Windows)StringtotaltestUTconnectionId
StringcredentialsId
StringprojectFolder
StringtestSuite
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
Stringjcl
StringccClearStats (optional)
booleanccDB2 (optional)
booleanccPgmType (optional)
StringccRepo (optional)
StringccSystem (optional)
StringccTestId (optional)
StringdeleteTemp (optional)
booleanhlq (optional)
StringhostPort (optional)
StringuseStubs (optional)
booleantotaltestenvironmentId
StringfolderPath
StringserverUrl
StringcredentialsId
StringaccountInfo (optional)
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
StringccThreshhold (optional)
inthaltAtFailure (optional)
booleanrecursive (optional)
booleanreportFolder (optional)
StringsonarVersion (optional)
StringsourceFolder (optional)
StringstopIfTestFailsOrThresholdReached (optional)
booleanuploadToServer (optional)
booleanpublishTraceAnalysisPublishes the results of the trace analysis of all configured ECU-TEST packages or projects in this job.
Pipeline usage
publishTraceAnalysis(String toolName, boolean mergeReports, boolean createReportDir, int timeout) : void
publishTraceAnalysis(ETInstallation installation, boolean mergeReports, boolean createReportDir, int timeout,
boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ETInstance.publishTraceAnalysis(boolean mergeReports, boolean createReportDir, int timeout) : void
publishTraceAnalysis('ECU-TEST')
def instance = ET.installation('ECU-TEST')
publishTraceAnalysis installation: instance.installation, mergeReports: true, createReportDir: false
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishTraceAnalysis()
toolName
StringallowMissing (optional)
booleanarchiving (optional)
booleancreateReportDir (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
hudson.tools.ToolProperty>
keepAll (optional)
booleanmergeReports (optional)
booleanrunOnFailed (optional)
booleantimeout (optional)
StringtricentisCItricentisClientPath (optional)
Stringendpoint (optional)
StringconfigurationFilePath (optional)
StringUiPathDeploypackagePath
StringorchestratorAddress
StringorchestratorTenant
StringcredentialsId
StringUiPathPackversion
AutoVersionCustomVersiontext
StringprojectJsonPath
StringoutputPath
String$class: 'UnitTestBuilder'connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
Stringobjects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringowner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
Stringtxt
booleanxml
booleanazureVMSSUpdateazureCredentialsId
StringresourceGroup
Stringname
StringimageReference
id (optional)
Resource ID or VHD URI of the custom image.
Example Resource ID: /subscriptions/your-subscription-id/resourceGroups/your-resource-group/providers/Microsoft.Compute/images/your-image-name
Example VHD URI: http://your-storage-account.blob.core.windows.net/vhds/your-disk-image.vhd
Stringoffer (optional)
Stringpublisher (optional)
Stringsku (optional)
Stringversion (optional)
StringazureVMSSUpdateInstancesazureCredentialsId
StringresourceGroup
Stringname
StringinstanceIds
,'.
String$class: 'UpdaterPublisher'$class: 'UploadJUnitTestResult'properties
java.lang.String>
uploadProgetPackagefeedName
StringgroupName
A string of no more than fifty characters:
StringpackageName
A string of no more than fifty characters:
Stringversion
Stringartifacts
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
StringcaseSensitive (optional)
org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
booleandefaultExcludes (optional)
booleandependencies (optional)
Stringdescription (optional)
Stringexcludes (optional)
Stringicon (optional)
Stringmetadata (optional)
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
Stringtitle (optional)
A string of no more than fifty characters
StringuTesterUrlListTaskinitialUrl
StringurlsWhiteList
StringrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
int$class: 'VB6Builder'projectFile
StringcompileConstants (optional)
StringoutDir (optional)
StringvCommanderaction
$class: 'VCommanderRequestNewServiceAction'payload
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderRunWorkflowAction'targetType
StringtargetName
StringworkflowName
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderWaitForRequestNewServiceAction'requestId
Stringtimeout
longpolling
long$class: 'VCommanderWaitForRunWorkflowAction'taskId
Stringtimeout
longpolling
long$class: 'VSphereBuildStepContainer'buildStep
$class: 'Clone'sourceName
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringpowerOn
booleantimeoutInSeconds
intcustomizationSpec
String$class: 'ConvertToTemplate'vm
Stringforce
boolean$class: 'ConvertToVm'template
StringresourcePool
Stringcluster
String$class: 'Delete'vm
StringfailOnNoExist
boolean$class: 'DeleteSnapshot'vm
StringsnapshotName
Stringconsolidate
booleanfailOnNoExist
boolean$class: 'Deploy'template
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringcustomizationSpec
StringtimeoutInSeconds
intpowerOn
boolean$class: 'ExposeGuestInfo'vm
StringenvVariablePrefix
StringwaitForIp4
boolean$class: 'PowerOff'vm
StringevenIfSuspended
booleanshutdownGracefully
booleanignoreIfNotExists
booleangracefulShutdownTimeout (optional)
int$class: 'PowerOn'vm
StringtimeoutInSeconds
int$class: 'Reconfigure'vm
StringreconfigureSteps
$class: 'ReconfigureAnnotation'annotation (optional)
Stringappend (optional)
boolean$class: 'ReconfigureCpu'cpuCores
StringcoresPerSocket
String$class: 'ReconfigureDisk'diskSize
Stringdatastore
String$class: 'ReconfigureMemory'memorySize
String$class: 'ReconfigureNetworkAdapters'deviceAction
ADD, EDIT, REMOVEdeviceLabel
StringmacAddress
StringstandardSwitch
booleanportGroup
StringdistributedSwitch
booleandistributedPortGroup
StringdistributedPortId
String$class: 'Rename'oldName
StringnewName
String$class: 'RenameSnapshot'vm
StringoldName
StringnewName
StringnewDescription
String$class: 'RevertToSnapshot'vm
StringsnapshotName
String$class: 'SuspendVm'vm
String$class: 'TakeSnapshot'vm
StringsnapshotName
Stringdescription
StringincludeMemory
booleanserverName
String$class: 'ValgrindBuilder'valgrindExecutable
StringworkingDirectory
StringincludePattern
StringexcludePattern
StringoutputDirectory
StringoutputFileEnding
StringprogramOptions
Stringtool
$class: 'ValgrindToolHelgrind'historyLevel
String$class: 'ValgrindToolMemcheck'showReachable
booleanundefinedValueErrors
booleanleakCheckLevel
StringtrackOrigins
booleanvalgrindOptions
StringignoreExitCode
booleantraceChildren
booleanchildSilentAfterFork
booleangenerateSuppressions
booleansuppressionFiles
StringremoveOldReports
boolean$class: 'ValgrindPublisher'pattern
StringfailThresholdInvalidReadWrite
StringfailThresholdDefinitelyLost
StringfailThresholdTotal
StringunstableThresholdInvalidReadWrite
StringunstableThresholdDefinitelyLost
StringunstableThresholdTotal
StringsourceSubstitutionPaths
StringpublishResultsForAbortedBuilds
booleanpublishResultsForFailedBuilds
booleanfailBuildOnMissingReports
booleanfailBuildOnInvalidReports
booleancrxValidatepackageIdFilters (optional)
**/*.zip
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zip
Matching packages will be validated in the order in which the filters are specified. At least one package must match each filter or the step will fail.
StringallowNonCoveredRoots (optional)
booleanforbiddenACHandlingModeSet (optional)
StringforbiddenExtensions (optional)
.jar
.zip
This field supports parameter tokens.
StringforbiddenFilterRootPrefixes (optional)
/apps/system
/apps/system/config
/apps/systemOfADown/config
StringlocalDirectory (optional)
StringpathsDeniedForInclusion (optional)
/apps/system/rep:policy
/etc/map/http/site_root_redirect
Use this test to safeguard specific paths or possible paths within unrestricted roots from overly broad workspace filters.
StringvalidationFilter (optional)
/etc # define /etc as the filter root
-/etc/packages(/.)? # exclude package paths
This field supports parameter tokens.
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
StringvariablesPrefix
StringvariablesSuffix
StringemptyValue
Stringconfigs
name
Stringvalue
String$class: 'VectorCASTCommand'winCommand
StringunixCommand
String$class: 'VectorCASTPublisher'includes
StringuseThreshold
booleanhealthyTarget
minStatement
intmaxStatement
intminBranch
intmaxBranch
intminBasisPath
intmaxBasisPath
intminMCDC
intmaxMCDC
intminFunction
intmaxFunction
intminFunctionCall
intmaxFunctionCall
intunhealthyTarget
minStatement
intmaxStatement
intminBranch
intmaxBranch
intminBasisPath
intmaxBasisPath
intminMCDC
intmaxMCDC
intminFunction
intmaxFunction
intminFunctionCall
intmaxFunctionCall
int$class: 'VectorCASTSetup'environmentSetupWin
StringenvironmentSetupUnix
StringexecutePreambleWin
StringexecutePreambleUnix
StringenvironmentTeardownWin
StringenvironmentTeardownUnix
StringoptionUseReporting
booleanoptionErrorLevel
StringoptionHtmlBuildDesc
StringoptionExecutionReport
booleanoptionClean
booleanwaitLoops
longwaitTime
longmanageProjectName
StringjobName
StringnodeLabel
String$class: 'ViewCloner'url
StringreplacePatternString
StringniewViewName
Stringpassword
Stringusername
StringViolationsToBitbucketServerSee Violation Comments to Bitbucket Server Plugin for details on how to configure and use this plugin.
Pattern is a regular expression for matching report files. For example .*/findbugs/.*\.xml$ matches xml-files, in a folder named findbugs, anywhere in workspace.
config
projectKey
StringrepoSlug
StringpullRequestId
StringbitbucketServerUrl (optional)
StringcommentOnlyChangedContent (optional)
booleancommentOnlyChangedContentContext (optional)
intcommentOnlyChangedFiles (optional)
booleancommentTemplate (optional)
StringcreateCommentWithAllSingleFileComments (optional)
booleancreateSingleFileComments (optional)
booleancreateSingleFileCommentsTasks (optional)
booleancredentialsId (optional)
StringkeepOldComments (optional)
booleanmaxNumberOfViolations (optional)
intminSeverity (optional)
INFO, WARN, ERRORviolationConfigs (optional)
reporter
Stringpattern
Stringparser
ANDROIDLINT, CHECKSTYLE, CODENARC, CLANG, CPD, CPPCHECK, CPPLINT, CSSLINT, FINDBUGS, FLAKE8, FXCOP, GENDARME, IAR, JCREPORT, JSHINT, JUNIT, LINT, KLOCWORK, KOTLINMAVEN, KOTLINGRADLE, MSCPP, MYPY, GOLINT, GOOGLEERRORPRONE, PERLCRITIC, PITEST, PMD, PYDOCSTYLE, PYLINT, RESHARPER, SBTSCALAC, SIMIAN, SONAR, STYLECOP, XMLLINT, YAMLLINT, ZPTLINT, DOCFX, PCLINTViolationsToGitHubSee Violation Comments to GitHub Plugin for details on how to configure and use this plugin.
Pattern is a regular expression for matching report files. For example .*/findbugs/.*\.xml$ matches xml-files, in a folder named findbugs, anywhere in workspace.
config
repositoryName
StringrepositoryOwner
StringpullRequestId
StringgitHubUrl
StringcommentOnlyChangedContent (optional)
booleancommentOnlyChangedFiles (optional)
booleancommentTemplate (optional)
StringcreateCommentWithAllSingleFileComments (optional)
booleancreateSingleFileComments (optional)
booleancredentialsId (optional)
StringkeepOldComments (optional)
booleanmaxNumberOfViolations (optional)
intminSeverity (optional)
INFO, WARN, ERRORoAuth2Token (optional)
StringviolationConfigs (optional)
reporter
Stringpattern
Stringparser
ANDROIDLINT, CHECKSTYLE, CODENARC, CLANG, CPD, CPPCHECK, CPPLINT, CSSLINT, FINDBUGS, FLAKE8, FXCOP, GENDARME, IAR, JCREPORT, JSHINT, JUNIT, LINT, KLOCWORK, KOTLINMAVEN, KOTLINGRADLE, MSCPP, MYPY, GOLINT, GOOGLEERRORPRONE, PERLCRITIC, PITEST, PMD, PYDOCSTYLE, PYLINT, RESHARPER, SBTSCALAC, SIMIAN, SONAR, STYLECOP, XMLLINT, YAMLLINT, ZPTLINT, DOCFX, PCLINTViolationsToGitLabSee Violation Comments to GitLab Plugin for details on how to configure and use this plugin.
Pattern is a regular expression for matching report files. For example .*/findbugs/.*\.xml$ matches xml-files, in a folder named findbugs, anywhere in workspace.
config
gitLabUrl
StringprojectId
StringmergeRequestIid
StringapiToken (optional)
StringapiTokenCredentialsId (optional)
StringapiTokenPrivate (optional)
booleanauthMethodHeader (optional)
booleancommentOnlyChangedContent (optional)
booleancommentOnlyChangedFiles (optional)
booleancommentTemplate (optional)
StringcreateCommentWithAllSingleFileComments (optional)
booleancreateSingleFileComments (optional)
booleanenableLogging (optional)
booleanignoreCertificateErrors (optional)
booleankeepOldComments (optional)
booleanmaxNumberOfViolations (optional)
intminSeverity (optional)
INFO, WARN, ERRORproxyPassword (optional)
StringproxyUri (optional)
StringproxyUser (optional)
StringshouldSetWip (optional)
booleanviolationConfigs (optional)
parser
ANDROIDLINT, CHECKSTYLE, CODENARC, CLANG, CPD, CPPCHECK, CPPLINT, CSSLINT, FINDBUGS, FLAKE8, FXCOP, GENDARME, IAR, JCREPORT, JSHINT, JUNIT, LINT, KLOCWORK, KOTLINMAVEN, KOTLINGRADLE, MSCPP, MYPY, GOLINT, GOOGLEERRORPRONE, PERLCRITIC, PITEST, PMD, PYDOCSTYLE, PYLINT, RESHARPER, SBTSCALAC, SIMIAN, SONAR, STYLECOP, XMLLINT, YAMLLINT, ZPTLINT, DOCFX, PCLINTpattern
Stringreporter
StringvsTestcmdLineArgs (optional)
Stringenablecodecoverage (optional)
Enables data diagnostic adapter CodeCoverage in the test run.
Default settings are used if not specified using settings file.
Command Line Argument: /Enablecodecoverage
booleanfailBuild (optional)
booleanframework (optional)
Target .NET Framework version to be used for test execution.
Valid values are Framework35, Framework40 and Framework45.
Command Line Argument: /Framework: [ framework version ]
StringinIsolation (optional)
Runs the tests in an isolated process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
booleanlogger (optional)
Specify a logger for test results. For example, to log results into a Visual Studio Test Results File (TRX) use /Logger:trx.
Command Line Argument: /Logger:[ uri/friendlyname ]
Stringplatform (optional)
Target platform architecture to be used for test execution.
Valid values are x86, x64 and ARM.
Stringsettings (optional)
Run tests with additional settings such as data collectors.
Example: Local.RunSettings
Command Line Argument: /Settings:[ file name ]
StringtestCaseFilter (optional)
Run tests that match the given expression.
<Expression> is of the format <property>=<value>[||<Expression>].
Example: TestCategory=Nightly||Name=Namespace.ClassName.MethodName
The TestCaseFilter command line option cannot be used with the Tests command line option.
Command Line Argument: /TestCaseFilter:[ expression ]
StringtestFiles (optional)
Specify the path to your VSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line or space.
Stringtests (optional)
Run tests with names that match the provided values.
To provide multiple values, separate them by commas.
Example: TestMethod1,testMethod2
The /Tests command line option cannot be used with the /TestCaseFilter command line option.
Command Line Argument: /Tests:[ test name ]
StringuseVs2017Plus (optional)
This makes adjustments to the arguments for the sake of compatibility with Visual Studio 2017+.
Command Line Argument: /UseVs2017Plus:true
booleanuseVsixExtensions (optional)
This makes vstest.console.exe process use or skip the VSIX extensions installed (if any) in the test run.
Command Line Argument: /UseVsixExtensions:true
booleanvsTestName (optional)
StringazureUploadstorageCredentialId
StringfilesPath
StringstorageType
StringallowAnonymousAccess (optional)
booleanblobProperties (optional)
cacheControl
StringcontentEncoding
StringcontentLanguage
StringcontentType
StringdetectContentType
Auto detect content type based on file content and file name if content type is not set.
This detection is provided by Apache Tika and may not always be accurate.
booleancleanUpContainerOrShare (optional)
booleancontainerName (optional)
StringdoNotFailIfArchivingReturnsNothing (optional)
booleandoNotUploadIndividualFiles (optional)
booleandoNotWaitForPreviousBuild (optional)
booleanexcludeFilesPath (optional)
StringfileShareName (optional)
Stringmetadata (optional)
key
Stringvalue
StringonlyUploadModifiedArtifacts (optional)
booleanpubAccessible (optional)
booleanuploadArtifactsOnlyIfSuccessful (optional)
booleanuploadZips (optional)
booleanvirtualPath (optional)
String$class: 'WaptPro'reportsFolder
StringreportFiles
StringcheckTestResult
booleanwarningscanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleancategoriesPattern (optional)
StringconsoleParsers (optional)
parserName
StringdefaultEncoding (optional)
StringexcludePattern (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
StringincludePattern (optional)
StringmessagesPattern (optional)
StringparserConfigurations (optional)
pattern
StringparserName
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'WarriorPluginBuilder'configType
StringgitConfigUrl
StringgitConfigCredentials
booleangitConfigTagValue
StringgitConfigCloneType
StringgitConfigUname
StringgitConfigPwd
StringgitConfigFile
StringsftpConfigIp
StringsftpConfigUname
StringsftpConfigPwd
StringsftpConfigFile
StringpythonPath
StringuploadExecLog
booleanuploadServerIp
StringuploadServerUname
StringuploadServerPwd
StringuploadServerType
StringuploadServerDir
StringrunFiles
runFile
StringazureWebAppPublishazureCredentialsId
StringappName
StringresourceGroup
StringdeleteTempImage (optional)
booleandeployOnlyIfSuccessful (optional)
booleandockerFilePath (optional)
StringdockerImageName (optional)
StringdockerImageTag (optional)
StringdockerRegistryEndpoint (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringfilePath (optional)
The file paths that will be deployed.
You can use wildcards like module/dist/**/*.py. See the includes attribute of Ant fileset for the exact format. Multiple files can be separated by ','. The base directory is the workspace. You can only deploy files that are located in your workspace.
Examples:
Java
webapps/*.war **/*.zip Note: For Java application, if you choose WAR deployment, usually you should put your war file under the 'webapps' directory.
PHP
**/*.php,composer.json Python
**/*.py,requirements.txt Node.js
**/*.js,package.json,process.json StringpublishType (optional)
StringskipDockerBuild (optional)
booleanslotName (optional)
If not blank, will deploy to this deployment slot instead of the default production slot.
See this article for more details.
StringsourceDirectory (optional)
StringtargetDirectory (optional)
StringazureWebAppSwapSlotsazureCredentialsId
StringresourceGroup
StringappName
StringsourceSlotName
StringtargetSlotName
String$class: 'WhiteSourcePublisher'jobCheckPolicies
StringjobForceUpdate
StringjobApiToken
StringjobUserKey
Stringproduct
StringproductVersion
StringprojectToken
StringlibIncludes
StringlibExcludes
StringmavenProjectToken
StringrequesterEmail
StringmoduleTokens
StringmodulesToInclude
StringmodulesToExclude
StringignorePomModules
boolean$class: 'WinDocksBuilder'ipaddress
Stringimage
StringwinRMClienthostName
StringcredentialsId
StringwinRMOperations
invokeCommandcommand
StringsendFilesource
Stringdestination
StringconfigurationName
StringcleanWscleanWhenAborted (optional)
booleancleanWhenFailure (optional)
booleancleanWhenNotBuilt (optional)
booleancleanWhenSuccess (optional)
booleancleanWhenUnstable (optional)
booleancleanupMatrixParent (optional)
booleandeleteDirs (optional)
booleandisableDeferredWipeout (optional)
booleanexternalDelete (optional)
StringnotFailBuild (optional)
booleanpatterns (optional)
pattern
Stringtype
INCLUDE, EXCLUDEskipWhenFailed (optional)
booleanxcodeBuildallowFailingBuildResults (optional)
Checking this option will prevent a build step from failing if xcodebuild exits with a non-zero return code.
This can be useful for build steps that run unit tests and also have a post-build task to publish unit test results: the test step will not fail the entire build for a failing unit test, but will instead mark the build unstable in the "publish test" phase.
booleanappURL (optional)
StringassetPackManifestURL (optional)
StringassetPacksBaseURL (optional)
StringassetPacksInBundle (optional)
booleanbuildDir (optional)
The value to use for the BUILD_DIR setting. You only need to supply this value if you want the product of the Xcode build to be in a location other than the one specified in project settings and this job 'SYMROOT' parameter.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringbuildIpa (optional)
Checking this option will create a .ipa for each .app found in the build directory.
An .ipa is basically a zipped up .app.
This is quite handy for distributing ad-hoc builds to testers as they can just double-click the .ipa and it will import into iTunes.
booleanbundleID (optional)
The new bundle ID. Usually something like com.companyname.projectname.
StringbundleIDInfoPlistPath (optional)
The path to the info.plist file which contains the CFBundleIdentifier of your project.
Usually something like:
StringcfBundleShortVersionStringValue (optional)
This will set the CFBundleShortVersionString to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
StringcfBundleVersionValue (optional)
This will set the CFBundleVersion to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example the value ${BUILD_NUMBER} will be replaced with the current build number.
We advice you to generate a unique value for each build if you want for example deploy it into a private store.
In that case, for example, you can use : ${JOB_NAME}-${BUILD_NUMBER}
StringchangeBundleID (optional)
Checking this option will replace the bundle identifier.
You will need to specify which bundle ID (CFBundleIdentifier) to use and where is the Info.plist file located.
This is handy for example when you want to use a different code signing identity in your development projects.
booleancleanBeforeBuild (optional)
This will delete the build directories before invoking the build. This will force the rebuilding of ALL dependencies and can make large projects take a lot longer.
booleancleanResultBundlePath (optional)
This will delete the ResultBundlePath before invoking the build.
If the directory already exists in the location specified by ResultBundlePath, xcodebuild will be an error and should be checked.
booleancleanTestReports (optional)
booleancompileBitcode (optional)
booleanconfiguration (optional)
This is the name of the configuration as defined in the Xcode project.
By default there are Debug and Release configurations.
StringcopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringgenerateArchive (optional)
Checking this option will create an .xcarchive .app found in the build directory.
An .xcarchive is useful for submission to the app store or third party crash reporters.
You must specify a Scheme to perform an archive.
booleanignoreTestResults (optional)
booleaninterpretTargetAsRegEx (optional)
Build all entries listed under the "Targets:" section of the xcodebuild -list output that match the regexp.
booleanipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainName (optional)
The name of this configured keychain. Each job will specify a keychain configuration by the name.
StringkeychainPath (optional)
The path of the keychain to use to retrieve certificates to sign the package (default : ${HOME}/Library/Keychains/login.keychain).
StringkeychainPwd (optional)
The password of the keychain to use to retrieve certificates to sign the package.
hudson.util.Secret
logfileOutputDirectory (optional)
Specify the directory to output the log of xcodebuild.
If you leave it blank, it will be output to "project directory/builds/${BUILD_NUMBER}/log" with other logs.
If an output path is specified, it is output as a xcodebuild.log file in a relative directory under the "build output directory"
StringmanualSigning (optional)
booleannoConsoleLog (optional)
booleanprovideApplicationVersion (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresultBundlePath (optional)
Specify the directory to output the output the test result.
If you leave it blank, it will not output a test result and will not analyze the test results.
If an output path is specified, it is output as a test result in a relative directory under the "ResultBundlePath".
The plug-in analyzes the test result here and outputs a JUnit compatible XML file under the ${WORKSPACE}/test-reports.
Stringsdk (optional)
You only need to supply this value if you want to specify the SDK to build against. If empty, the SDK will be determined by Xcode. If you wish to run OCUnit tests, you will need to use the iPhone Simulator's SDK, for example:
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.1.sdk/
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
You only need to supply this value if you want to specify the SYMROOT path to use.
If empty, the default SYMROOT path will be used (it could be different depending of your Xcode version).
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/symroot
Stringtarget (optional)
The target to build. If left empty, this will build all targets in the project.
If you wish to build your binary and the unit test module, it is best to do this as two separate steps each with their own target.
This was, the iPhone Simulator SDK can be specified for the unit tests.
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanuseLegacyBuildSystem (optional)
Instead of "New Builld System" which became available from Xcode 9, we build the application using the legacy build system.
There is a possibility that you can handle old projects that cause problems with the new build system.
Also, since new output formats of logs are changed in the new build system, it is also useful when you want to handle logs with legacy third party tools.
booleanxcodeName (optional)
StringxcodeProjectFile (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringxcodebuildArguments (optional)
Extra xcodebuild parameters, added after the command that jenkins generates based on the rest of the config
String$class: 'XFramiumBuilder'configFile
StringsuiteName
StringtestNames
StringtagNames
StringstepTags
StringdeviceTags
StringdefaultCloud
StringoverrideDefaults
boolean$class: 'XLRVarSetterBuilder'XLR_releaseId
StringXLR_varName
StringJKS_varName
Stringdebug
booleanosfBuilderSuiteXMLLintxsdsPath (optional)
StringxmlsPath (optional)
StringreportPath (optional)
String$class: 'XUnitBuilder'tools
AUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanBoostTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCheckpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'CpptestPluginType'pattern
StringfailIfNotNew
booleandeleteOutputFiles
booleanCustompattern
StringcustomXSL
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanembUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanFPCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleangtesterpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'GallioPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanGoogleTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'JSUnitPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanJUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMSTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMbUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit3pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit2pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanPHPUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftSOAtest9xType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanQtTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'SCTMTestType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanUnitTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanValgrindpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanxUnitDotNetpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'hudson.plugins.testcomplete.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
String$class: 'jenkins.plugins.xunit.tc11.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
Stringthresholds
failedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringpassedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringskippedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringthresholdMode
inttestTimeMargin
StringreduceLog (optional)
booleanxUnitImporteruri
StringcredentialsId
StringtestSetTrackerId
inttestCaseTrackerId
inttestRunTrackerId
inttestConfigurationId
intbugTrackerId (optional)
intbuild (optional)
StringexcludedPackages (optional)
StringincludedPackages (optional)
StringnumberOfBugsToReport (optional)
intreleaseId (optional)
intrequirementDepth (optional)
intrequirementParentId (optional)
intrequirementTrackerId (optional)
inttestCaseParentId (optional)
inttruncatePackageTree (optional)
String$class: 'XUnitPublisher'tools
AUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanBoostTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCheckpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanCppUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'CpptestPluginType'pattern
StringfailIfNotNew
booleandeleteOutputFiles
booleanCustompattern
StringcustomXSL
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanembUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanFPCUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleangtesterpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'GallioPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanGoogleTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'JSUnitPluginType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanJUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMSTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanMbUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit3pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanNUnit2pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanPHPUnitpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftSOAtest9xType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'ParasoftType'pattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanQtTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'SCTMTestType'pattern
StringfaildedIfNotNew
booleandeleteOutputFiles
booleanUnitTestpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanValgrindpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleanxUnitDotNetpattern
StringskipNoTestFiles
booleanfailIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
boolean$class: 'hudson.plugins.testcomplete.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
String$class: 'jenkins.plugins.xunit.tc11.TestCompleteTestType'pattern
StringfailedIfNotNew
booleandeleteOutputFiles
booleanstopProcessingIfError
booleantestFilterPattern
Stringthresholds
failedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringpassedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringskippedfailureNewThreshold (optional)
StringfailureThreshold (optional)
StringunstableNewThreshold (optional)
StringunstableThreshold (optional)
StringthresholdMode
inttestTimeMargin
StringreduceLog (optional)
booleantestDataPublishers (optional)
$class: 'AttachmentPublisher'$class: 'AutomateTestDataPublisher'$class: 'ClaimTestDataPublisher'$class: 'JUnitFlakyTestDataPublisher'jiraTestResultReporterconfigs
jiraSelectableArrayFieldfieldKey
Stringvalues
value
StringjiraSelectableFieldfieldKey
Stringvalue
StringjiraStringArrayFieldfieldKey
Stringvalues
value
StringjiraStringFieldfieldKey
Stringvalue
Insert a string value.
You can include Jenkins Environment variables (see link), or the following variables defined by this plugin:
Variable usage: ${VAR_NAME}CRFL - new line
DEFAULT_SUMMARY - configured in the global configuration page
DEFAULT_DESCRIPTION - configured in the global configuration page
TEST_RESULT
TEST_NAME
TEST_FULL_NAME
TEST_STACK_TRACE
TEST_ERROR_DETAILS
TEST_DURATION
TEST_PACKAGE_NAME
TEST_STDERR
TEST_STDOUT
TEST_OVERVIEW
TEST_AGE
TEST_PASS_COUNT
TEST_SKIPPED_COUNT
TEST_FAIL_SINCE
TEST_IS_REGRESSION - expands to true/false
BUILD_RESULT
String$class: 'UserFields'fieldKey
Stringvalue
Insert the username.
For example if you have a user with:
Display Name: John Doe, Username: johndoe, Email: johndoe@email.com,
you need to write johndoe in this field. Any other value (like display name, or email) will not work.
StringprojectKey
StringissueType
StringautoRaiseIssue
booleanautoResolveIssue
booleanautoUnlinkIssue
boolean$class: 'JunitResultPublisher'urlOverride
String$class: 'PerfSigTestDataPublisher'dynatraceProfile
String$class: 'SahaginTestDataPublishser'$class: 'SauceOnDemandReportPublisher'jobVisibility (optional)
String$class: 'StabilityTestDataPublisher'$class: 'TestReporter'xUnitUploadercodebeamerUrl (optional)
StringcredentialsId (optional)
StringtestConfigurationId (optional)
inttestCaseTrackerId (optional)
inttestCaseId (optional)
intreleaseId (optional)
inttestRunTrackerId (optional)
inttestResultsDir (optional)
StringdefaultPackagePrefix (optional)
Stringdisabled (optional)
boolean$class: 'ZOSJobSubmitter'server
Stringport
intcredentialsId
Stringwait
booleanwaitTime
intdeleteJobFromSpool
booleanjobLogToConsole
booleanjobFile
StringMaxCC
StringJESINTERFACELEVEL1
boolean$class: 'ZanataCliBuilder'projFile
StringsyncG2zanata
booleansyncZ2git
booleanzanataCredentialsId
StringextraPathEntries (optional)
String$class: 'ZanataSyncStep'zanataCredentialsId
StringpullFromZanata (optional)
booleanpushToZanata (optional)
booleansyncOption (optional)
StringzanataLocaleIds (optional)
StringzanataProjectConfigs (optional)
StringzanataURL (optional)
StringzoomNotifierauthToken (optional)
StringincludeCommitInfo (optional)
booleanincludeFailedTests (optional)
booleanincludeTestSummary (optional)
booleannotifyAborted (optional)
booleannotifyBackToNormal (optional)
booleannotifyFailure (optional)
booleannotifyNotBuilt (optional)
booleannotifyRegression (optional)
booleannotifyRepeatedFailure (optional)
booleannotifyStart (optional)
booleannotifySuccess (optional)
booleannotifyUnstable (optional)
booleanwebhookUrl (optional)
StringzulipNotificationstream (optional)
Stringtopic (optional)
StringzulipSendmessage (optional)
Stringstream (optional)
Stringtopic (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncApiToken (optional)
StringncProfileId (optional)
StringncServerURL (optional)
String$class: 'com.aliyun.www.cos.DeployBuilder'masterurl
StringappName (optional)
StringcomposeTemplate (optional)
StringcredentialsId (optional)
StringpublishStrategy (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncApiToken (optional)
StringncProfileId (optional)
StringncServerURL (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftBuildVerifier'apiURL
StringbldCfg
Stringnamespace
StringauthToken
Stringverbose
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftBuilder'apiURL
StringbldCfg
Stringnamespace
Stringenv
name
Stringvalue
StringauthToken
Stringverbose
StringcommitID
StringbuildName
StringshowBuildLogs
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftCreator'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftDeleterJsonYaml'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftDeleterLabels'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
Stringvalues
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftDeleterList'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftDeployer'apiURL
StringdepCfg
Stringnamespace
StringauthToken
Stringverbose
StringwaitTime
StringwaitUnit
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftDeploymentVerifier'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftExec'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringpod
Stringcontainer
Stringcommand
Stringarguments
value
StringwaitTime
StringwaitUnit
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftImageTagger'apiURL
StringtestTag
StringprodTag
Stringnamespace
StringauthToken
Stringverbose
StringtestStream
StringprodStream
StringdestinationNamespace
StringdestinationAuthToken
Stringalias
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftScaler'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'com.openshift.jenkins.plugins.pipeline.OpenShiftServiceVerifier'apiURL
StringsvcName
Stringnamespace
StringauthToken
Stringverbose
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftBuildVerifier'bldCfg
StringapiURL (optional)
StringauthToken (optional)
StringcheckForTriggeredDeployments (optional)
Stringnamespace (optional)
Stringverbose (optional)
StringwaitTime (optional)
StringwaitUnit (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftBuilder'bldCfg
StringapiURL (optional)
StringauthToken (optional)
StringbuildName (optional)
StringcheckForTriggeredDeployments (optional)
StringcommitID (optional)
Stringenv (optional)
name
Stringvalue
Stringnamespace (optional)
StringshowBuildLogs (optional)
Stringverbose (optional)
StringwaitTime (optional)
StringwaitUnit (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftCreator'jsonyaml
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
Stringverbose (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftDeleterJsonYaml'jsonyaml
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
Stringverbose (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftDeleterLabels'types
Stringkeys
Stringvalues
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
Stringverbose (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftDeleterList'types
Stringkeys
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
Stringverbose (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftDeployer'depCfg
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
Stringverbose (optional)
StringwaitTime (optional)
StringwaitUnit (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftDeploymentVerifier'depCfg
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
StringreplicaCount (optional)
Stringverbose (optional)
StringverifyReplicaCount (optional)
StringwaitTime (optional)
StringwaitUnit (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftExec'pod
StringapiURL (optional)
Stringarguments (optional)
value
StringauthToken (optional)
Stringcommand (optional)
Stringcontainer (optional)
Stringnamespace (optional)
Stringverbose (optional)
StringwaitTime (optional)
StringwaitUnit (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftImageTagger'srcStream
StringsrcTag
StringdestStream
StringdestTag
Stringalias (optional)
StringapiURL (optional)
StringauthToken (optional)
StringdestinationAuthToken (optional)
StringdestinationNamespace (optional)
Stringnamespace (optional)
Stringverbose (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftScaler'depCfg
StringreplicaCount
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
Stringverbose (optional)
StringverifyReplicaCount (optional)
StringwaitTime (optional)
StringwaitUnit (optional)
String$class: 'com.openshift.jenkins.plugins.pipeline.dsl.OpenShiftServiceVerifier'svcName
StringapiURL (optional)
StringauthToken (optional)
Stringnamespace (optional)
StringretryCount (optional)
Stringverbose (optional)
StringcomponentapplicationName (optional)
Stringasync (optional)
booleancomponentName (optional)
Stringpayload (optional)
io.alauda.model.Kubernete
resourceType (optional)
Stringrollback (optional)
booleantimeout (optional)
int$class: 'io.alauda.jenkins.plugins.pipeline.dsl.component.RetrieveStep'applicationName (optional)
StringcomponentName (optional)
StringresourceType (optional)
String$class: 'io.alauda.jenkins.plugins.pipeline.dsl.integration.RetrieveStep'instanceUUID (optional)
Stringserviceasync (optional)
booleancreatePayload (optional)
io.alauda.model.ServiceCreatePayload
projectName (optional)
Stringrollback (optional)
booleanserviceID (optional)
Stringtimeout (optional)
intupdatePayload (optional)
io.alauda.model.ServiceUpdatePayload
$class: 'io.alauda.jenkins.plugins.pipeline.dsl.service.RetrieveStep'serviceID (optional)
StringserviceName (optional)
StringandroidLintcanComputeNew (optional)
booleancanResolveRelativePaths (optional)
booleancanRunOnFailed (optional)
booleandefaultEncoding (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewLow (optional)
StringfailedNewNormal (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalLow (optional)
StringfailedTotalNormal (optional)
Stringhealthy (optional)
Stringpattern (optional)
StringshouldDetectModules (optional)
booleanthresholdLimit (optional)
StringunHealthy (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewLow (optional)
StringunstableNewNormal (optional)
StringunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalLow (optional)
StringunstableTotalNormal (optional)
StringuseDeltaValues (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
boolean$class: 'org.jenkinsci.plugins.cflint.LintPublisher'healthy (optional)
StringunHealthy (optional)
StringthresholdLimit (optional)
StringdefaultEncoding (optional)
StringuseDeltaValues (optional)
booleanunstableTotalAll (optional)
StringunstableTotalHigh (optional)
StringunstableTotalNormal (optional)
StringunstableTotalLow (optional)
StringunstableNewAll (optional)
StringunstableNewHigh (optional)
StringunstableNewNormal (optional)
StringunstableNewLow (optional)
StringfailedTotalAll (optional)
StringfailedTotalHigh (optional)
StringfailedTotalNormal (optional)
StringfailedTotalLow (optional)
StringfailedNewAll (optional)
StringfailedNewHigh (optional)
StringfailedNewNormal (optional)
StringfailedNewLow (optional)
StringcanRunOnFailed (optional)
booleanshouldDetectModules (optional)
booleancanComputeNew (optional)
booleanpattern (optional)
StringcanResolveRelativePaths (optional)
booleanusePreviousBuildAsReference (optional)
booleanuseStableBuildAsReference (optional)
booleanosfBuilderSuiteForSFCCDeployhostname (optional)
StringbmCredentialsId (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringbuildVersion (optional)
StringcreateBuildInfoCartridge (optional)
booleanactivateBuild (optional)
booleansourcePaths (optional)
sourcePath
StringexcludePatterns
excludePattern
StringtempDirectory (optional)
Stringtimeout: Enforce time limittime
intactivity (optional)
booleanunit (optional)
NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYStool: Use a tool from a predefined Tool InstallationConfigure System are available here. If the original tool installer has the auto-provision feature, then the tool will be installed as required.
name
Stringtype (optional)
Stringunstable: Set stage result to unstableUNSTABLE. The message will also be associated with the stage result and may be shown in visualizations.
message
Stringunstash: Restore files previously stashedstashed into the current workspace.
name
StringwaitUntil: Wait for conditiontrue. If it returns
false, waits a while and tries again. (Subsequent failures will slow down the delay between attempts.) There is no limit to the number of retries, but if the body throws an error that is thrown up immediately.
warnError: Catch error and set build and stage result to unstableUNSTABLE, prints a specified message and the thrown exception to the build log, and associates the stage result with the message so that it can be displayed by visualizations.
Equivalent to catchError(message: message, buildResult: 'UNSTABLE', stageResult: 'UNSTABLE').
message
StringcatchInterruptions (optional)
timeout step.
booleanwithEnv: Set environment variables
node {
withEnv(['MYTOOL_HOME=/usr/local/mytool']) {
sh '$MYTOOL_HOME/bin/start'
}
}
(Note that here we are using single quotes in Groovy, so the variable expansion is being done by the Bourne shell, not Jenkins.)
See the documentation for the env singleton for more information on environment variables.
overrides
VARIABLE=value or
VARIABLE= to unset variables otherwise defined. You may also use the syntax
PATH+WHATEVER=/something to prepend
/something to
$PATH.
Stringwrap: General Build WrapperThis is a special step that allows to call build wrappers (also called "Environment Configuration" in freestyle or similar projects). Just select the wrapper to use from the dropdown list and configure it as needed. Everything inside the wrapper block is under its effect.
Note that only Pipeline-compatible wrappers will be shown in the list.
delegate
$class: 'AnsiColorBuildWrapper'colorMapName
StringwithAntinstallation (optional)
Name of an Ant installation to use so that ant will be in the path.
Stringjdk (optional)
Name of an Java installation to use when running Ant.
StringwithAWSParameterStorecredentialsId (optional)
StringnamePrefixes (optional)
Stringnaming (optional)
Stringpath (optional)
Stringrecursive (optional)
booleanregionName (optional)
StringwithAzureKeyvaultazureKeyVaultSecrets
secretType (optional)
Stringname (optional)
Stringversion (optional)
StringenvVariable (optional)
StringapplicationIDOverride (optional)
StringapplicationSecretOverride (optional)
StringcredentialIDOverride (optional)
StringkeyVaultURLOverride (optional)
String$class: 'BuildScanBuildWrapper'$class: 'BuildUser'$class: 'CacheWrapper'maxCacheSize
longcaches
$class: 'ArbitraryFileCache'path
Stringincludes
Stringexcludes
String$class: 'ChefIdentityBuildWrapper'jobIdentity
String$class: 'CloudCoreoBuildWrapper'teamName
Stringcontext
String$class: 'CodeBuilderLogger'configFileProvidermanagedFiles
fileId
Name of the file.
StringreplaceTokens (optional)
Decides whether the token should be replaced using macro.
booleantargetLocation (optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
Stringvariable (optional)
Name of the variable which can be used as the reference for further configuration.
String$class: 'ConsulKVReadWrapper'reads
aclToken
StringhostUrl
Stringkey
StringenvKey
StringapiUri (optional)
StringdebugMode (optional)
ENABLED, DISABLEDignoreGlobalSettings (optional)
booleantimeoutConnect (optional)
inttimeoutResponse (optional)
intwithCoverityEnvcoverityToolName
StringconnectInstance (optional)
StringhostVariable (optional)
StringpasswordVariable (optional)
StringportVariable (optional)
StringusernameVariable (optional)
StringwithCoverityEnvironmentcoverityInstanceUrl
Specify which Synopsys Coverity connect instance to run this job against.
StringconfigureChangeSetPatterns (optional)
changeSetExclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be excluded |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringchangeSetInclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly included from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be included |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringprojectName (optional)
Specify the name of the Coverity project.
The resulting project name is stored in the $COV_PROJECT environment variable, and will affect both the full and incremental analysis
StringstreamName (optional)
Specify the name of the Coverity stream that you would like to use for the commands.
The resulting stream name is stored in the $COV_STREAM environment variable, and will affect both the full and incremental analysis.
StringviewName (optional)
Specify the name of the Coverity view that you would like to check for issues.
The resulting view name is stored in the $COV_VIEW environment variable, and affects checking for issues in both the full and incremental analysis, if configured.
String$class: 'DockerMachineWrapper'name
StringexpiryDays
String$class: 'ElasTestBuildWrapper'It allows you to send the logs of the Job Execution to ElasTest and if you need a browser in your test you can use the EUS service.
eus (optional)
booleanin_toto_wrapcredentialId (optional)
StringkeyPath (optional)
StringstepName (optional)
Stringtransport (optional)
String$class: 'JiraCreateReleaseNotes'jiraProjectKey
Specify JIRA project key. A project key is the all capitals part before the issue number in JIRA.
(EXAMPLE-100)
StringjiraRelease
Specify the name of the parameter which will contain the release version. This can reference a build parameter.
StringjiraEnvironmentVariable
Specify the environment variable to which the release notes will be stored, defaults to RELEASE_NOTES.
This can be used in another build step which supports environments.
StringjiraFilter
Apply additional filtering criteria to the issue filter. This will be concatenated with an AND operator.
Defaults To:
status in (Released, Closed)
StringwithKafkaLogkafkaServers
StringkafkaTopic
Stringmetadata
StringklocworkWrapperserverConfig
StringinstallConfig
StringserverProject
Stringltoken
String$class: 'LogfilesizecheckerWrapper'maxLogSize
intfailBuild
booleansetOwn
boolean$class: 'MaskPasswordsBuildWrapper'When enabled, allows masking passwords that may appear in the console.
Passwords or regexes to be masked can be defined at three levels.
First, it is possible to select in Hudson's/Jenkins' configuration screen the build parameters whose value must be masked. For example, selecting the Password Parameter type is a good idea.
Second, still in Hudson's/Jenkins' configuration screen, it is possible to define passwords to be masked as global Name/Password pairs, or regexes to be masked.
Third, on a per job basis (that is, in the current configuration screen), passwords to be masked can be defined as local Name/Password pairs, or regexes can be masked:
varPasswordPairs
var
Stringpassword
StringvarMaskRegexes
regex
String$class: 'MesosSingleUseSlave'nodejsnodeJSInstallationName
StringcacheLocationStrategy (optional)
defaultexecutorworkspaceconfigId (optional)
String$class: 'OpenEdgeBuildWrapper'openEdgeInstall
StringwithFolderProperties$class: 'PolyspaceBuildWrapper'binConfig (optional)
Choose the Polyspace installation folder to be used in this project, as defined on the Configure System page.
You can then use Polyspace commands such as polyspace-configure, polyspace-bug-finder-server and polyspace-code-prover-server directly in scripts without specifying the installation folder.
You can also use the helper utility ps_helper in scripts in the Build section of this project to filter results, report a pass/fail status and obtain other project information. For instance, in a Shell script, use the utility with the syntax $ps_helper. In a Windows batch file, use the syntax %ps_helper%. In the syntax descriptions below, report refers to the results file obtained using the command polyspace-access -export or polyspace-report-generator -generate-results-list-file.
$ps_helper -report-filter report filtered_report [owner] [title1 value1] [title2 value2] ...
Filters report for results with title1 set to value1, etc. and saves to filtered_report (with name suffix _owner). The name owner is added to a list of owners for personalized e-mail notification later.
For instance:
$ps_helper -report-filter Results_List.tsv Results_Users.tsv userA Group Programming Function "get()"
Results_List.tsv for results with Group set to Programming and Function set to get().Results_Users_userA.tsv. You can later use the base name Results_Users to e-mail filtered reports to multiple users as a post-build action. For instance, you can send file Results_Users_userA.tsv to userA@emailExtension.com, file Results_Users_userB.tsv to userB@emailExtension.com, etc.$ps_helper -report-count-findings report
Stores the number of findings in report (original or filtered).
For instance:
NB_FINDINGS_USERA=$($ps_helper -report-count-findings Results_Users_userA.tsv)
Returns the number of findings in Results_Users_userA.tsv to the variable NB_FINDINGS_USERA.
$ps_helper -report-status report max
Prints an analysis status based on number of findings in report. If the number is greater than max, the build status is UNSTABLE. Otherwise, the status is SUCCESS.
For instance:
BUILD_STATUS=$($ps_helper -report-status Results_All.tsv 10)
Returns UNSTABLE to BUILD_STATUS if the number of findings in Results_All.tsv is greater than 10.
$ps_helper -print-runid upload_out
$ps_helper -print-projectid upload_out
$ps_helper -print-projecturl upload_out
Obtains a project id, run id and project URL in Polyspace Access for the current upload. The file upload_out is obtained when uploading a result with the command:
polyspace-access -o upload_out -upload ...
For instance:
PROJECT_ID=$($ps_helper -print-projectid upload_out)
Returns the ID of the project for the current upload to PROJECT_ID.
PROJECT_URL=$($ps_helper -print-projecturl upload_out $POLYSPACE_ACCESS_URL)
Returns the URL of the project for the current upload to PROJECT_URL. The variable $POLYSPACE_ACCESS_URL represents the URL of the Polyspace Access interface (created from specified server settings).
You can use the helper utility only when no Jenkins slave is used as the helper libraries are part of the Polyspace Jenkins plugin.
StringmetricsConfig (optional)
Choose the Polyspace Metrics server to be used in this project, as defined on the Configure System page.
You can then use these variables in scripts in the Build section of this project. For instance, in a Shell script, use these variables with the syntax $VAR. In a Windows batch file, use the syntax %VAR%.
POLYSPACE_METRICS_HOST is the hostname of the Polyspace Metrics server.POLYSPACE_METRICS_PORT is the port number of the Polyspace Metrics server.POLYSPACE_METRICS_URL is the URL of the Polyspace Metrics server.ps_helper_metrics_upload is a helper utlity to upload Polyspace results to the specified server. Syntax (shell scripts): $ps_helper_metrics_upload ResultsDirwhere
ResultsDir is a folder containing Polyspace results.StringpolyspaceAccessCredentialId (optional)
Select an username and encrypted password used to log on to Polyspace Access. You can also add a username and password. To update, delete or otherwise manage login credentials, go to the Configure Credentials page.
To obtain an encrypted password, at the command line, enter:.
Provide an LDAP login and password.polyspace-access -host hostname -port portnumber -encrypt-password
StringserverConfig (optional)
Choose the Polyspace Access server to be used in this project, as defined in the Configure System page.
You can then use these variables in scripts in the Build section of this project. For instance, in a Shell script, use these variables with the syntax $VAR. In a Windows batch file, use the syntax %VAR%.
POLYSPACE_ACCESS_HOST is the hostname of the Polyspace Access server.POLYSPACE_ACCESS_PROTOCOL is the protocol (http or https) of the Polyspace Access server.POLYSPACE_ACCESS_PORT is the port number of the Polyspace Access server.POLYSPACE_ACCESS_URL is the URL of the Polyspace Access server.ps_helper_access is a helper utlity to interact with the specified Polyspace Access server. Syntax (shell scripts): $ps_helper_access -upload ResultsDirwhere
ResultsDir is a folder containing Polyspace results. The helper utility expands to: polyspace-access -host hostname -port portnumber -login username -encrpyted-password pwdwhere the specified server settings and login credentials are used.
String$class: 'RepositoryDefinitionProperty'
<profile>
<id>jenkins</id>
<repositories>
<repository>
<id>jenkins</id>
<url>${env.Jenkins.Repository}</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>jenkins</id>
<url>${env.Jenkins.Repository}</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
upstream
$class: 'SelectionTypeProject'project
Stringbuild
Stringpromoted
String$class: 'SelectionTypeSpecified'path
String$class: 'SelectionTypeUpstream'build
StringbuildMasterWithApplicationReleaseRequests the Release Number for the selected BuildMaster application from BuildMaster and injects these environment variables into the build job:
Because the Release Number and build numbers could be required by several build and post-build actions selecting the application and setting up the environment variable has been separated from the trigger build action.
If you have multiple jobs all triggering builds on the same BuildMaster application this build step will queue those jobs so that you cannot get two jobs trigger a build at the same time.
applicationId
StringdeployableId (optional)
Select the BuildMaster deployable associated with this job. If selected, during a build the BUILDMASTER_DEPLOYABLE_ID environment variable will be populated with the deployable's id.
This is only required when using the trigger build action to enable a deployable.
StringpackageNumberSource (optional)
Select which build number to use to populate the BUILDMASTER_PACKAGE_NUMBER environment variable:
TIP: If have multiple Jenkins jobs triggering the one BuildMaster application build then use "Not Required", otherwise you are likely to run into a timing issue with the build numbers.
StringreleaseNumber (optional)
Select the BuildMaster release to trigger build for:
During a build the BUILDMASTER_RELEASE_NUMBER environment variable will be set with this value.
NOTE: if a specific release number is selected (for example an emergency patch might want to go on an earlier release than the latest one) this will become invalid once the release is finalised in BuildMaster. There may be scope for an enhancement here to provide alternative forms of matching on release number - eg by branch name.
StringwithSonarQubeEnvinstallationName
StringcredentialsId (optional)
StringappMonBuildEnvironmentThe below properties will be available as build variables in all the build steps during build. You can use them to register test run on your own (in your scripts).
Also the properties set in global plugin configuration ("Dynatrace Application Monitoring" config section) will be available as build variables: 'dtServerUrl', 'dtUsername' and 'dtPassword'.
NOTE:
If you decide not to use the below properties in your scripts and to register test runs on your own, please fill at least the "System profile" field to have the post-build action working properly.
systemProfile
Stringmarker (optional)
StringrecordSession (optional)
booleanversionMajor (optional)
StringversionMilestone (optional)
StringversionMinor (optional)
StringversionRevision (optional)
String$class: 'TimestamperBuildWrapper'$class: 'VaultBuildWrapper'vaultSecrets
path
StringsecretValues
envVar
StringvaultKey
Stringconfiguration (optional)
vaultUrl (optional)
StringvaultCredentialId (optional)
String$class: 'Xvfb'additionalOptions (optional)
StringassignedLabels (optional)
StringautoDisplayName (optional)
booleandebug (optional)
booleandisplayName (optional)
intdisplayNameOffset (optional)
intinstallationName (optional)
StringparallelBuild (optional)
booleanscreen (optional)
1024x758x16
StringshutdownWithBuild (optional)
booleantimeout (optional)
long$class: 'Xvnc'takeScreenshot
booleanuseXauthority
boolean$class: 'org.csanchez.jenkins.plugins.kubernetes.KubectlBuildWrapper'serverUrl
StringcredentialsId
StringcaCertificate
Leaving this field empty will skip the certificate verification.
String$class: 'org.jenkinsci.plugins.kubernetes.cli.KubectlBuildWrapper'caCertificate (optional)
Leaving this field empty will skip the certificate verification.
StringclusterName (optional)
StringcontextName (optional)
StringcredentialsId (optional)
Stringnamespace (optional)
StringserverUrl (optional)
StringwriteFile: Write file to workspacefile
Stringtext
Stringencoding (optional)
Stringarchive: Archive artifactsarchiveArtifacts.
includes
Stringexcludes (optional)
StringgetContext: Get contextual object from internal APIs Obtains a contextual object as in StepContext.get; cf. withContext. Takes a single type argument. Example:
getContext hudson.FilePath
For use from trusted code, such as global libraries, which can manipulate internal Jenkins APIs.
type
java.lang.Class>
withContext: Use contextual object from internal APIs within a block Wraps a block in a contextual object as in BodyInvoker.withContext; cf. getContext. Takes a single context argument plus a block. Example:
withContext(new MyConsoleLogFilter()) {
sh 'process'
}
Automatically merges its argument with contextual objects in the case of ConsoleLogFilter, LauncherDecorator, and EnvironmentExpander.
For use from trusted code, such as global libraries, which can manipulate internal Jenkins APIs.
context
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.